Project

General

Profile

« Previous | Next » 

Revision 8813

put web/.twiki/data/TWiki/TWikiPreferences.txt under version control

View differences:

inputs/VegBIEN/TWiki/data/TWiki/TWikiPreferences.txt
1
%META:TOPICINFO{author="TWikiContributor" date="1357464271" format="1.1" version="87"}%
2
---+!! <nop>%WIKITOOLNAME% Site-Level Preferences
3

  
4
This topic defines __site-level__ settings that apply to all users and webs on this TWikiSite.
5

  
6
<div class="twikiNotification"> __%X% NOTE:__ Don't edit this topic, changes will be lost on the next TWiki upgrade. Define new site-level settings, or overload below settings in [[%LOCALSITEPREFS%]] </div>
7

  
8
Preference settings local to your site should be set in [[%LOCALSITEPREFS%]] (this topic is pointed to by {LocalSitePreferences}, which is set by the admin in the [[%SCRIPTURLPATH{"configure"}%][configure]] interface). Settings in [[%LOCALSITEPREFS%]] will override settings in this topic, and should be used for defining custom settings and variables.
9

  
10
[[TWikiVariables#PreferencesVariables][Read more]] on how to set Preferences Variables.
11

  
12
%TOC%
13

  
14
#DefaultWebPreferences
15
---++ Default Web Preferences
16

  
17
%X% *NOTE:* These are just defaults; don't change them here. Instead, add them to the !WebPreferences topic in each web
18

  
19
   * List of selected topics in a web (used in menus)
20
      * Set WEBTOPICLIST = [[WebChanges][Changes]] %SEP% [[WebIndex][Index]] %SEP% [[WebSearch][Search]] %SEP% Go <input type="text" name="topic" size="16" />
21

  
22
   * Web-specific background color: (is overwritten by web preferences)
23
      * Set WEBBGCOLOR = #FFD8AA
24

  
25
   * [[http://en.wikipedia.org/wiki/Favicon][favicon]]: Attach a =favicon.ico= to a web's WebPreferences or add a =FAVICON= setting to WebPreferences
26
      * Set FAVICON = %PUBURLPATH%/%BASEWEB%/%WEBPREFSTOPIC%/favicon.ico
27

  
28
   * Image, URL and alternate tooltip text of web's logo.
29
      * Set WEBLOGOIMG = %WIKILOGOIMG%
30
      * Set WEBLOGOURL = %WIKILOGOURL%
31
      * Set WEBLOGOALT = %WIKILOGOALT%
32

  
33
   * List this web in the %SYSTEMWEB%.SiteMap:
34
      * If yes, set SITEMAPLIST to =on=, 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. <nop>%WEB%.Topic links.
35
      * Set SITEMAPLIST = on
36
      * Set SITEMAPWHAT = Describe what this web does
37

  
38
#CopyrightNotice
39
   * Copyright notice:
40
      * Set WEBCOPYRIGHT = %MAKETEXT{"Copyright &&copy; [_1] by the contributing authors. All material on this collaboration platform is the property of the contributing authors." args="2008-%GMTIME{$year}%"}% <br /> %MAKETEXT{"Ideas, requests, problems regarding [_1]? <a href='[_2]'>Send feedback</a>" args="<nop>%WIKITOOLNAME%,mailto:%WIKIWEBMASTER%?subject=%WIKITOOLNAME%%20Feedback%20on%20%BASEWEB%.%BASETOPIC%"}%
41

  
42
   * Simplified Copyright notice for the WebRss feed (don't use any special characters, html tags, entities, wiki markup or WikiWords)
43
      * Set WEBRSSCOPYRIGHT = Copyright %GMTIME{"$year"}% by contributing authors
44

  
45
   * Exclude web from a =web="all"= search: (Set to =on= for hidden webs; is overwritten by web preferences) __Note__ it is much better to use 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.
46
      * Set NOSEARCHALL = 
47

  
48
   * Prevent automatic linking of [[%SYSTEMWEB%.WikiWords][WikiWords]] and acronyms (if set to =on=); link <nop>WikiWords (if empty); can be overwritten by web preferences:
49
      * Set NOAUTOLINK = 
50
      * __Note:__ Use the =[<nop>[...][...]]= syntax to link topics in case you disabled <nop>WikiWord linking. The =&lt;noautolink&gt; ... &lt;/noautolink&gt;= syntax can be used to prevents links within a block of text.
51

  
52
   * If you use non !WikiWords for topic names (for example "Expenses" or "Mighty1") and if you use bracket notation to link to those topics, it is useful to *turn of all warnings* (like: "WARNING: This topic name is not recommended because it will not be linked automatically") and checkboxes ("Allow non !WikiWord for the new topic name"). Can be overwritten by web preferences. Set to =on= to activate:
53
      * Set HIDE_NON_WIKI_WORD_WARNINGS =
54
      
55
   * Warn if =%<nop>INCLUDE{}%= of topic fails: Fail silently if empty or =off=. Output warning message (defined in templates/oopsalerts.tmpl) if set to =on=. Otherwise output specific text (use =$topic= for topic). You can override this in web preferences, or by using a =warn="..."= parameter with =%<nop>INCLUDE{}%= :
56
      * Set INCLUDEWARNING = on
57

  
58
#TableOfContents
59
   * Generated Table of Contents (TOC) settings
60
      * The first header level to appear in the TOC:
61
         * Set TOC_MIN_DEPTH =
62
            * If not set: =1=
63
            * Possible values: =1= to =6=
64
      * The last header level to appear in the TOC:      
65
         * Set TOC_MAX_DEPTH =
66
            * If not set: =6=
67
            * Possible values: =1= to =6=
68
            * Can be overridden by =depth= parameter of [[%SYSTEMWEB%.VarTOC2][variable TOC]]
69
      * The default TOC title:
70
         * Set TOC_TITLE =
71
            * If not set: nothing
72
            * Possible values: any string, for example =On this page:=
73
            * Can be overridden by =title= parameter of [[%SYSTEMWEB%.VarTOC2][variable TOC]]
74
      * Do not show a TOC if the topic it contains is included in another topic:
75
         * Set TOC_HIDE_IF_INCLUDED =
76
            * If not set: included TOC is shown
77
            * Possible values: =on= or nothing
78

  
79
#DefaultUserSettings
80
---++ Default User Settings
81

  
82
%X% *NOTE:* They are typically redefined in topics of individual %USERSWEB%.TWikiUsers
83

  
84
   * Preference for the editor, default is the WYSIWYG editor. The options are raw, wysiwyg:
85
      * Set EDITMETHOD = wysiwyg
86
      * #Set EDITMETHOD = raw
87

  
88
   * Fixed [[%SYSTEMWEB%.TopMenuSkin#FixedTopMenu][pulldown menu-bar]], on or off. If on, the menu-bar is always visible at the top, regardless of the window scroll position. If off, the menu-bar hides when scrolled, and can be shown by hovering over the gray TWiki icon.
89
      * Set FIXEDTOPMENU = off
90

  
91
   * Show tool-tip topic info on mouse-over of 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 <nop>WikiName, $wikiusername for <nop>%USERSWEB%.WikiName, $topic for the topic name, and $web for the web name
92
      * Set LINKTOOLTIPINFO = off
93
      * #Set LINKTOOLTIPINFO = $username - $date - $rev: $summary
94

  
95
   * Horizontal size of text edit box:
96
      * Set EDITBOXWIDTH = 70
97

  
98
   * Vertical size of text edit box:
99
      * Set EDITBOXHEIGHT = 22
100

  
101
   * 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.
102
      * Set EDITBOXSTYLE = width:99%
103

  
104
   * Default state of the __Force New Revision__ (ForceNewRevision) check box in preview. Check box is initially checked if =Set FORCENEWREVISIONCHECKBOX = checked="checked"=, or unchecked if empty:
105
      * Set FORCENEWREVISIONCHECKBOX = 
106

  
107
   * 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:
108
      * Set DONTNOTIFYCHECKBOX = 
109

  
110
   * 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:
111
      * Set ATTACHLINKBOX = 
112

  
113
   * Format of file link when the __link__ check box is checked:
114
      * %H% *NOTE:* Keyword ==$name== gets expanded to filename; ==$comment== to comment; ==\t== to tab (3 spaces for bullets).
115
<!-- verbatim tag required to prevent error in Apache log; does not suppress Set -->
116
<verbatim>
117
      * Set ATTACHEDFILELINKFORMAT = \n   * [[%PUBURLPATH%/%WEB%/%TOPIC%/$name][$name]]: $comment
118
</verbatim>
119

  
120
   * Format of images when the __link__ check box is checked:
121
      * %H% *NOTE:* Keyword ==$name== gets expanded to filename; ==$comment== to comment; ==$width== to width of image; ==$height== to height of image; ==$size== to ==width="..." height="..."== attribute of ==img== tag; ==\t== to tab and ==\n== to linefeed. Use 3 leading spaces for bullets.
122
<verbatim>
123
      * Set ATTACHEDIMAGEFORMAT = \n   * $comment: <br />\n     <img src="%PUBURLPATH%/%WEB%/%TOPIC%/$name" alt="$name" $size />
124
</verbatim>
125

  
126
#TWikiPlatformSettings
127
---++ TWiki Platform Settings
128

  
129
   * TWiki site name:
130
      * Set WIKITOOLNAME = TWiki
131

  
132
   * Image, URL and alternate tooltip text of the logo *for this installation*: you should change these settings for your site, or they can be overwridden in !WebPreferences for individual webs by defining these variables there.
133
      * Set WIKILOGOIMG = %PUBURL%/%SYSTEMWEB%/TWikiLogos/T-logo-140x40-t.gif
134
      * Set WIKILOGOURL = %SCRIPTURL{view}%/%USERSWEB%/%HOMETOPIC%
135
      * Set WIKILOGOALT = Home - this site is powered by TWiki(R)
136

  
137
   * Home page of this site. This is DEPRECATED, please use %<nop>WIKILOGOURL% instead.
138
      * Set WIKIHOMEURL = %SCRIPTURLPATH{"view"}%/%USERSWEB%/%HOMETOPIC%
139

  
140
   * List of <nop>%WIKITOOLNAME% webs - on the first line of the upper toolbar (to add a new web, see ManagingWebs and %SYSTEMWEB%.SiteMap):
141
      * Set WIKIWEBLIST = [[%USERSWEB%.%HOMETOPIC%][%USERSWEB%]] %SEP% [[%SYSTEMWEB%.%HOMETOPIC%][%SYSTEMWEB%]] %SEP% [[Sandbox.%HOMETOPIC%][Sandbox]]
142
      * %T% *NOTE:* To automatically list all non-hidden webs in alphabetical order, use the =%<nop>WEBLIST{}%= variable instead: <br />
143
        %WEBLIST{"[[$name.%HOMETOPIC%][$name]]" separator=" | "}%
144

  
145
   * Maximum size of %SYSTEMWEB%.FileAttachments in KB, 0 for no limit:
146
      * Set ATTACHFILESIZELIMIT = 10000
147

  
148
#BroadcastMessage
149
   * Broadcast message for skins supporting a %<nop>BROADCASTMESSAGE% at the top of the page: (IMPORTANT: Set to empty message if not used; #Comment out unused messages)
150
      * Set BROADCASTMESSAGE = 
151
      * #Set BROADCASTMESSAGE = *NOTE:* 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 <nop>%WIKITOOLNAME% maintenance.
152

  
153
   * Users or groups allowed to [[%SYSTEMWEB%.ManagingWebs][create new top-level webs]]: (ex: %USERSWEB%.WebCreatorsGroup). If set to nothing, only administrators will be able to do this.
154
      * Set ALLOWROOTCHANGE = %USERSWEB%.TWikiAdminGroup
155

  
156
#SearchSettings
157
---+++ Search Settings
158

  
159
   * Default type for search, one of: keyword (for search engine like syntax), regex (for RegularExpression search), or literal (for verbatim search)
160
      * Set SEARCHDEFAULTTYPE = keyword
161
   * Default for =%<nop>SEARCH{}%= variable, one of: keyword, regex, or literal
162
      * Set SEARCHVARDEFAULTTYPE = literal
163
   * Stop words, e.g., common words and characters to exclude from a keyword search:
164
      * 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
165

  
166
#EmailSettings
167
---+++ E-mail Settings
168

  
169
   * 'Mail this topic' mailto: link - can be included in topics, templates or skins
170
      * Set MAILTHISTOPIC = <a href="mailto:?subject=%BASETOPIC%&amp;body=%TOPICURL%">%MAILTHISTOPICTEXT%</a>
171

  
172
   * 'Mail this topic' link text
173
      * Set MAILTHISTOPICTEXT = Send a link to this page
174

  
175
#HttpEquivSettings
176
---+++ HTTP-<nop>EQUIV Settings
177

  
178
   * %T% *NOTE:* 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.
179
   * *NOTE:* The current values of these preferences are not displayed in view mode (values are <code>&lt;link&gt;</code>-tags).
180

  
181
   * ==http-equiv== meta tags for ==view==, ==rdiff==, ==attach==, ==search*== scripts:
182
      * #Set HTTP_EQUIV_ON_VIEW = 
183
      * Set HTTP_EQUIV_ON_VIEW = <link rel="alternate" type="application/rss+xml" title="RSS Feed" href="%SCRIPTURLPATH{"view"}%/%WEB%/WebRss" />
184

  
185
   * ==http-equiv== meta tags for ==edit== script:
186
      * Set HTTP_EQUIV_ON_EDIT = 
187

  
188
   * ==http-equiv== meta tags for ==preview== script:
189
      * Set HTTP_EQUIV_ON_PREVIEW = 
190

  
191
#SkinSettings
192
---++ Skin Settings
193

  
194
   * Skin overriding the default TWiki templates: (can be overwritten by WebPreferences and user preferences) 
195
      * Set SKIN = tagme, topmenu, pattern
196

  
197
   * __Note:__ See TWikiSkinBrowser for currently installed skins
198

  
199
#PatternSkin
200
---+++ Pattern Skin
201

  
202
   * Default TWiki styles of PatternSkin
203
      * Set TWIKILAYOUTURL = %PUBURLPATH%/%SYSTEMWEB%/PatternSkin/layout.css
204
      * Set TWIKISTYLEURL = %PUBURLPATH%/%SYSTEMWEB%/PatternSkin/style.css
205
      * Set TWIKICOLORSURL = %PUBURLPATH%/%SYSTEMWEB%/PatternSkin/colors.css
206

  
207
   * Custom overriding styles (enabled pr. default but empty, to prevent browsers from fetching %<nop>USERLAYOUTURL%-style URLs)
208
      * Set USERLAYOUTURL = 
209
      * Set USERSTYLEURL = 
210
      * Set USERCOLORSURL = 
211

  
212
   * *PatternSkin header settings*
213
      * Set WEBHEADERART = %PUBURLPATH%/%SYSTEMWEB%/PatternSkin/TWiki_header.gif
214
      * #Set WEBHEADERBGCOLOR = #faf8f0
215

  
216
#SkinIcons
217
---+++ Skin Icons
218

  
219
   * Topic containing the icon graphics library. Icons can easily be rendered with =%<nop>ICON{name}%=.
220
      * Set ICONTOPIC = %SYSTEMWEB%.TWikiDocGraphics, %USERSWEB%.SiteDocGraphics
221

  
222
#LegacySupport
223
---+++ Legacy Support
224

  
225
   * Support for legacy "EDITTOPIC", used to be hard-coded, now replaced by TMPL:P conditional instantiation
226
      * Set EDITURL = %SCRIPTURLPATH{"edit"}%/%WEB%/%TOPIC%?t=%GMTIME{"$epoch"}%
227
      * Set EDITTOPIC = <a href="%EDITURL%" title="Edit Topic - deprecated usage - please see release notes">Edit</a>
228

  
229
#PluginsSettings
230
---++ Plugins Settings
231

  
232
   * You can enable/disable Plugins using the [[%SCRIPTURLPATH{"configure"}%][configure]] interface.
233
   * You can also disable installed plugins in individual webs/topics by defining the %<nop>DISABLEDPLUGINS% TWiki variable to be a list of plugins to disable e.g.
234
      * <nop>Set DISABLEDPLUGINS = SpreadSheetPlugin,EditTablePlugin
235
      * Currently, %<nop>DISABLEDPLUGINS% is set to "%DISABLEDPLUGINS%"
236
   * Currently activated Plugins: %ACTIVATEDPLUGINS%
237

  
238
   * %T% *NOTE:* You can enable/disable Plugins by passing a comma-separated list of Plugin names in the =debugenableplugins= url parameter; for example, %SCRIPTURL{"view"}%/%WEB%/%TOPIC%?debugenableplugins=SmiliesPlugin will display this topic with all Plugins disabled except the SmiliesPlugin.
239
   * Detailed diagnostics can be found in InstalledPlugins
240
   * Legacy settings:
241
      * Set INSTALLEDPLUGINS = The INSTALLEDPLUGINS variable is no longer supported. You can set the Plugins execution order using the [[%SCRIPTURLPATH{"configure"}%][configure]] interface.
242

  
243
<!-- Legacy settings for !CommentPlugin:
244
   * Name of file in the 'templates' directory that contains the comment templates:
245
      * Set COMMENTPLUGIN_TEMPLATES = comments
246
   * Default template type:
247
      * Set COMMENTPLUGIN_DEFAULT_TYPE = above
248
-->
249

  
250
#RenderingShortcuts
251
---++ Rendering Shortcuts Settings
252

  
253
   * Line break and bullet with different levels of indentation:
254
      * Set BB = <br />&#8226;
255
      * Set BB2 = <br />&nbsp;&nbsp;&#8226;
256
      * Set BB3 = <br />&nbsp;&nbsp;&nbsp;&nbsp;&#8226;
257
      * Set BB4 = <br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8226;
258

  
259
   * Line break: Note that the setting has an intentional trailing space
260
      * Set BR = <br /> 
261

  
262
   * Bullet sign:
263
      * Set BULLET = &#8226;
264

  
265
   * Vertical caret symbol:
266
      * Set CARET = &#94;
267

  
268
   * URL of current topic
269
      * Set TOPICURL = %SCRIPTURL{"view"}%/%WEB%/%BASETOPIC%
270

  
271
   * Vertical bar / pipe symbol:
272
      * Set VBAR = &#124;
273

  
274
   * __Hint:__ Above shortcuts are useful in TWiki tables where you cannot use newlines
275

  
276
#DocGraphics
277
   * 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.)_:
278
      * Set H = <img src="%ICONURLPATH{help}%" alt="HELP" title="HELP" width="16" height="16" border="0" />
279
      * Set I = <img src="%ICONURLPATH{tip}%" alt="IDEA!" title="IDEA!" width="16" height="16" border="0" />
280
      * Set M = <img src="%ICONURLPATH{arrowright}%" alt="MOVED TO..." title="MOVED TO..." width="16" height="16" border="0" />
281
      * Set N = <img src="%ICONURLPATH{new}%" alt="NEW" title="NEW" width="30" height="16" border="0" />
282
      * Set P = <img src="%ICONURLPATH{pencil}%" alt="REFACTOR" title="REFACTOR" width="16" height="16" border="0" />
283
      * Set Q = <img src="%ICONURLPATH{help}%" alt="QUESTION?" title="QUESTION?" width="16" height="16" border="0" />
284
      * Set S = <img src="%ICONURLPATH{starred}%" alt="PICK" title="PICK" width="16" height="16" border="0" />
285
      * Set T = <img src="%ICONURLPATH{tip}%" alt="TIP" title="TIP" width="16" height="16" border="0" />
286
      * Set U = <img src="%ICONURLPATH{updated}%" alt="UPDATED" title="UPDATED" width="55" height="16" border="0" />
287
      * Set X = <img src="%ICONURLPATH{warning}%" alt="ALERT!" title="ALERT!" width="16" height="16" border="0" />
288
      * Set Y = <img src="%ICONURLPATH{choice-yes}%" alt="DONE" title="DONE" width="16" height="16" border="0" />
289

  
290
#ColoredText
291
   * Colored text: (see more StandardColors)
292
     | You type: | =%<nop>RED% red text %<nop>ENDCOLOR% and %<nop>GREEN% green text %<nop>ENDCOLOR%= |
293
     | You get: | %RED% red text %ENDCOLOR% and %GREEN% green text %ENDCOLOR% |
294
      * __Note:__ =%&lt;color&gt;%= text must end with =%<nop>ENDCOLOR%=. If you want to switch from one color to another one you first need to end the active color with =%<nop>ENDCOLOR%=, such as =%<nop>RED% some text %<nop>ENDCOLOR% %<nop>GREEN% more text %<nop>ENDCOLOR%=.
295
        <!-- Two sets of colors follow: Color test and color setting -->
296
      * %YELLOW% *%<nop>YELLOW% looks like this* %ENDCOLOR%
297
      * %ORANGE% *%<nop>ORANGE% looks like this* %ENDCOLOR%
298
      * %RED% *%<nop>RED% looks like this* %ENDCOLOR%
299
      * %PINK% *%<nop>PINK% looks like this* %ENDCOLOR%
300
      * %PURPLE% *%<nop>PURPLE% looks like this* %ENDCOLOR%
301
      * %TEAL% *%<nop>TEAL% looks like this* %ENDCOLOR%
302
      * %NAVY% *%<nop>NAVY% looks like this* %ENDCOLOR%
303
      * %BLUE% *%<nop>BLUE% looks like this* %ENDCOLOR%
304
      * %AQUA% *%<nop>AQUA% looks like this* %ENDCOLOR%
305
      * %LIME% *%<nop>LIME% looks like this* %ENDCOLOR%
306
      * %GREEN% *%<nop>GREEN% looks like this* %ENDCOLOR%
307
      * %OLIVE% *%<nop>OLIVE% looks like this* %ENDCOLOR%
308
      * %MAROON% *%<nop>MAROON% looks like this* %ENDCOLOR%
309
      * %BROWN% *%<nop>BROWN% looks like this* %ENDCOLOR%
310
      * %BLACK% *%<nop>BLACK% looks like this* %ENDCOLOR%
311
      * %GRAY% *%<nop>GRAY% looks like this* %ENDCOLOR%
312
      * %SILVER% *%<nop>SILVER% looks like this* %ENDCOLOR%
313
      * <span style='background : #808080;'>%WHITE% *%<nop>WHITE% looks like this (with gray background)* %ENDCOLOR%</span>
314
      * The following settings define the colors: (they are enclosed in verbatim tags to avoid incorrect nesting of XHTML tags)
315
<verbatim>
316
      * Set YELLOW = <span style="color: #ffff00">
317
      * Set ORANGE = <span style="color: #ff6600">
318
      * Set RED = <span style="color: #ff0000">
319
      * Set PINK = <span style="color: #ff00ff">
320
      * Set PURPLE = <span style="color: #800080">
321
      * Set TEAL = <span style="color: #008080">
322
      * Set NAVY = <span style="color: #000080">
323
      * Set BLUE = <span style="color: #0000ff">
324
      * Set AQUA = <span style="color: #00ffff">
325
      * Set LIME = <span style="color: #00ff00">
326
      * Set GREEN = <span style="color: #008000">
327
      * Set OLIVE = <span style="color: #808000">
328
      * Set MAROON = <span style="color: #800000">
329
      * Set BROWN = <span style="color: #996633">
330
      * Set BLACK = <span style="color: #000000">
331
      * Set GRAY = <span style="color: #808080">
332
      * Set SILVER = <span style="color: #c0c0c0">
333
      * Set WHITE = <span style="color: #ffffff">
334
      * Set ENDCOLOR = </span>
335
</verbatim>
336

  
337
#ColoredBackground
338
   * Colored background: (see more StandardColors)
339
     | You type: | =%<nop>REDBG% red background %<nop>ENDBG% | %<nop>GREENBG% green background %<nop>ENDBG%= |
340
     | You get: | %REDBG% red background %ENDBG% | %GREENBG% green background %ENDBG% |
341
      * __Note:__ These background colors are block level elements, e.g. take up a whole row of text by default. Useful to set background colors in cells of TWiki tables.
342
        <!-- Two sets of colors follow: Color test and color setting -->
343
      * %YELLOWBG% *%<nop>YELLOWBG% looks like this* %ENDBG%
344
      * %ORANGEBG% *%<nop>ORANGEBG% looks like this* %ENDBG%
345
      * %REDBG% *%<nop>REDBG% looks like this* %ENDBG%
346
      * %PINKBG% *%<nop>PINKBG% looks like this* %ENDBG%
347
      * %PURPLEBG% *%<nop>PURPLEBG% looks like this* %ENDBG%
348
      * %TEALBG% *%<nop>TEALBG% looks like this* %ENDBG%
349
      * %NAVYBG% *%<nop>NAVYBG% looks like this* %ENDBG%
350
      * %BLUEBG% *%<nop>BLUEBG% looks like this* %ENDBG%
351
      * %AQUABG% *%<nop>AQUABG% looks like this* %ENDBG%
352
      * %LIMEBG% *%<nop>LIMEBG% looks like this* %ENDBG%
353
      * %GREENBG% *%<nop>GREENBG% looks like this* %ENDBG%
354
      * %OLIVEBG% *%<nop>OLIVEBG% looks like this* %ENDBG%
355
      * %MAROONBG% *%<nop>MAROONBG% looks like this* %ENDBG%
356
      * %BROWNBG% *%<nop>BROWNBG% looks like this* %ENDBG%
357
      * <span style="color:#ffffff">%BLACKBG% *%<nop>BLACKBG% looks like this* %ENDBG%</span>
358
      * %GRAYBG% *%<nop>GRAYBG% looks like this* %ENDBG%
359
      * %SILVERBG% *%<nop>SILVERBG% looks like this* %ENDBG%
360
      * %WHITEBG% *%<nop>WHITEBG% looks like this* %ENDBG%
361
      * The following settings define the background colors: (they are enclosed in verbatim tags to avoid incorrect nesting of XHTML tags)
362
<verbatim>
363
      * Set YELLOWBG = <div style="background-color: #ffff80; padding:0 3px 0 3px">
364
      * Set ORANGEBG = <div style="background-color: #ffbb80; padding:0 3px 0 3px">
365
      * Set REDBG = <div style="background-color: #ff8080; padding:0 3px 0 3px">
366
      * Set PINKBG = <div style="background-color: #ff80ff; padding:0 3px 0 3px">
367
      * Set PURPLEBG = <div style="background-color: #dd99dd; padding:0 3px 0 3px">
368
      * Set TEALBG = <div style="background-color: #80c0c0; padding:0 3px 0 3px">
369
      * Set NAVYBG = <div style="background-color: #8080c0; padding:0 3px 0 3px">
370
      * Set BLUEBG = <div style="background-color: #8080ff; padding:0 3px 0 3px">
371
      * Set AQUABG = <div style="background-color: #80ffff; padding:0 3px 0 3px">
372
      * Set LIMEBG = <div style="background-color: #80ff80; padding:0 3px 0 3px">
373
      * Set GREENBG = <div style="background-color: #99cc99; padding:0 3px 0 3px">
374
      * Set OLIVEBG = <div style="background-color: #c0c080; padding:0 3px 0 3px">
375
      * Set MAROONBG = <div style="background-color: #c08080; padding:0 3px 0 3px">
376
      * Set BROWNBG = <div style="background-color: #bb9988; padding:0 3px 0 3px">
377
      * Set BLACKBG = <div style="background-color: #000000; padding:0 3px 0 3px">
378
      * Set GRAYBG = <div style="background-color: #a0a0a0; padding:0 3px 0 3px">
379
      * Set SILVERBG = <div style="background-color: #c0c0c0; padding:0 3px 0 3px">
380
      * Set WHITEBG = <div style="background-color: #ffffff; padding:0 3px 0 3px">
381
      * Set ENDBG = </div>
382
</verbatim>
383

  
384
#MiscellaneousSettings
385
---++ Miscellaneous Settings
386

  
387
   * Format of a NewWikiWord link:
388
   * Note that =$text= is the topic link text, =$summary= is the HTML-cleaned topic link text, =$topic= is the name of the new topic, and =$web= is the name of the web for the new topic. Values are taken from the link syntax =[<nop>[$web.$topic][$text]]=. For normal plain !WikiWord links =$text= and =$topic= are the same. The value of =$web= is the current web unless the link is in the format =$web.$topic=.
389
      * default setting:
390
         * Set NEWLINKFORMAT = <span class="twikiNewLink"><a href="%SCRIPTURLPATH{"edit"}%/$web/$topic?topicparent=%WEB%.%TOPIC%;nowysiwyg=%IF{ "$ EDITMETHOD='wysiwyg'" then="0" else="1"  }%" rel="nofollow" title="%MAKETEXT{"$summary (this topic does not yet exist; you can create it)"}%">$text</a></span>
391
      * alternative setting:
392
         * #Set NEWLINKFORMAT = <a class="twikiNewLink" href="%SCRIPTURLPATH{"edit"}%/$web/$topic?topicparent=%WEB%.%TOPIC%" rel="nofollow" title="%MAKETEXT{"Create this topic"}%">$text</a>
393

  
394
   * %SYSTEMWEB%.PreviewBackground image:
395
      * Set PREVIEWBGIMAGE = %PUBURLPATH%/%SYSTEMWEB%/PreviewBackground/preview2bg.gif
396

  
397
   * User-friendly synonyms for system webs
398
      * Set DOCWEB = %SYSTEMWEB%
399

  
400
   * Show extra help for !ApacheLogin users for %USERSWEB%.TWikiAdminUser login
401
      * Set ADMINLOGIN = %IF{"{LoginManager} = 'TWiki::LoginManager::ApacheLogin' AND NOT context authenticated"
402
        then="TWiki is configured using <nop>ApacheLogin, please [[%LOGINURL%][login]] as a normal user first. Then the Admin Login will replace this text"
403
        else="[[%SCRIPTURL{login}%?sudo=sudo;origurl=%SCRIPTURL{"view"}%/%BASEWEB%/%BASETOPIC%][internal admin login]] (use the username suggested and the password set in configure)."}%
404

  
405
#SecuritySettings
406
---++ Security Settings
407

  
408
   * Only TWiki administrators are allowed to change this topic:
409
      * Set ALLOWTOPICCHANGE = %USERSWEB%.TWikiAdminGroup
410
      * Set ALLOWTOPICRENAME = %USERSWEB%.TWikiAdminGroup
411
   * Disable WYSIWYG editor for this preferences topic only:
412
      * Local TINYMCEPLUGIN_DISABLE = on
413

  
414
#NewPreferences
415
---++ Creating New Preference Variables
416

  
417
You can introduce new VARIABLES and use them in your topics and templates. There is no need to change the TWiki engine (Perl scripts).
418
   * A preference is defined in a TWikiShorthand bullet item: ==[3 spaces] * [space] Set NAME = value== <br /> Example (as a nested bullet item, indented 6 spaces):
419
      * S<nop>et WEBBGCOLOR = #FFFFC0
420
   * Preferences are used as %SYSTEMWEB%.TWikiVariables by enclosing the name in percent signs: ==%==. Example:
421
      * When you write variable ==%WEB<nop>BGCOLOR%==, it gets expanded to =%WEBBGCOLOR%= .
422

  
423
   * %X% The sequential order of the preference settings is significant. Define preferences that use other preferences FIRST. For example, set ==<nop>WEBCOPYRIGHT== before ==<nop>WIKIWEBMASTER== since the copyright notice uses the TWiki administrator e-mail address.
424
   * %X% In order to protect your custom variables from being overwritten when upgrading the [[%SYSTEMWEB%.%TOPIC%]] topic, it is recommended that custom variables are defined in [[%USERSWEB%.%TOPIC%]].
425

  
426
#ProtectedSystemSettings
427
---++ Protected System Settings
428

  
429
The following settings are declared final to protect them as read only. These are system variables that should 
430
never be attempted set or altered in any preference topic or topic settings. 
431

  
432
   * Set FINALPREFERENCES = WEB, TOPIC
433

  
434
#RelatedTopics
435
---++ Related Topics
436

  
437
   * %WEBPREFSTOPIC% has preferences of the <nop>%WEB% web.
438
   * User topics in %USERSWEB% can have optional user preferences.
439
   * %SYSTEMWEB%.TWikiVariables has a list of common =%<nop>VARIABLES%=.
440
   * %SYSTEMWEB%.TWikiAccessControl explains how to restrict access by users or groups.
441
   * %SYSTEMWEB%.PreferencesPlugin makes editing preferences a snap.
442

  
443
__Note__: Can't edit?
444
[[%SCRIPTURLPATH{"view"}%/%WEB%/%TOPIC%?raw=on][View raw topic]]
445

  
446
<div class="twikiNotification"> __%X% NOTE:__ Don't edit this topic, changes will be lost on the next TWiki upgrade. Define new site-level settings, or overload above settings in [[%LOCALSITEPREFS%]] </div>

Also available in: Unified diff