TWiki/TWikiPreferences.mdwn

   1 # <a name="%WIKITOOLNAME% Site-Level Prefer"></a><a name=" %WIKITOOLNAME% Site-Level Prefe"></a> %WIKITOOLNAME% Site-Level Preferences
   2
   3 This topic defines **_site-level_** settings that apply to all users and webs on this [[TWikiSite]].
   4
   5 **_%X% Note:_** This topic should be regarded as read-only, so that upgrades can safely overwrite it without risk to your customizations.
   6
   7 Preference settings local to your site should be set in [[Main.TWikiPreferences|Main/TWikiPreferences]] (this topic is pointed to by \{LocalSitePreferences\}, which is set by the admin in the [configure](http://www.dementia.org/twiki/configure) interface). Settings in [[Main.TWikiPreferences|Main/TWikiPreferences]] will override settings in this topic, and should be used for defining custom settings and variables.
   8
   9 [[Read more|Main/TWikiVariables#PreferencesVariables]] on how to set Preferences Variables.
  10
  11 <div>
  12   <ul>
  13     <li><a href="#Default Web Preferences"> Default Web Preferences</a></li>
  14     <li><a href="#Default User Settings"> Default User Settings</a></li>
  15     <li><a href="#TWiki Platform Settings"> TWiki Platform Settings</a><ul>
  16         <li><a href="#Search Settings"> Search Settings</a></li>
  17         <li><a href="#E-mail Settings"> E-mail Settings</a></li>
  18         <li><a href="#HTTP-EQUIV Settings"> HTTP-EQUIV Settings</a></li>
  19       </ul>
  20     </li>
  21     <li><a href="#Skin Settings"> Skin Settings</a><ul>
  22         <li><a href="#PatternSkin"> PatternSkin</a></li>
  23         <li><a href="#Skin icons"> Skin icons</a></li>
  24         <li><a href="#Legacy support"> Legacy support</a></li>
  25       </ul>
  26     </li>
  27     <li><a href="#Plugins Settings"> Plugins Settings</a></li>
  28     <li><a href="#Rendering Shortcuts Settings"> Rendering Shortcuts Settings</a></li>
  29     <li><a href="#Miscellaneous Settings"> Miscellaneous Settings</a></li>
  30     <li><a href="#Access Control Settings"> Access Control Settings</a></li>
  31     <li><a href="#Creating New Preference Variable"> Creating New Preference Variables</a></li>
  32     <li><a href="#Protected System Settings"> Protected System Settings</a></li>
  33     <li><a href="#Related Topics"> Related Topics</a></li>
  34   </ul>
  35 </div>
  36
  37 <a name="DefaultWebPreferences"></a>
  38
  39 ## <a name="Default Web Preferences"></a> Default Web Preferences
  40
  41 %X% **NOTE:** These are just defaults; don't change them here. Instead, add them to the WebPreferences topic in each web
  42
  43 - List of selected topics in a web (used in menus)
  44   - Set WEBTOPICLIST = [[Changes|Main/WebChanges]] | [[Index|Main/WebIndex]] | [[Search|Main/WebSearch]] | Go <input name="topic" size="16" type="text" />
  45
  46 - Web-specific background color: (is overwritten by web preferences)
  47   - Set WEBBGCOLOR = #FFD8AA
  48
  49 - [favicon](http://en.wikipedia.org/wiki/Favicon): Attach a `favicon.ico` to a web's [[WebPreferences]] or add a `FAVICON` setting to [[WebPreferences]]
  50   - Set FAVICON = <http://www.dementia.org/twiki//view/Main/WebPreferences/favicon.ico>
  51
  52 - Image, URL and alternate tooltip text of web's logo.
  53   - Set WEBLOGOIMG = %WIKILOGOIMG%
  54   - Set WEBLOGOURL = %WIKILOGOURL%
  55   - Set WEBLOGOALT = %WIKILOGOALT%
  56
  57 - List this web in the %SYSTEMWEB%.SiteMap:
  58   - 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. %WEB%.Topic links.
  59   - Set SITEMAPLIST = on
  60   - Set SITEMAPWHAT = Describe what this web does.
  61   - Set SITEMAPUSETO = ...to do something.
  62
  63 - Copyright notice:
  64   - Set WEBCOPYRIGHT = <span> [<img src="http://www.dementia.org/twiki//view/%SYSTEMWEB%/TWikiLogos/T-badge-88x31.gif" width="88" height="31" alt="This site is powered by the TWiki collaboration platform" title="This site is powered by the TWiki collaboration platform" />](http://twiki.org/)</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%? [Send feedback](mailto:?subject=%WIKITOOLNAME%%20Feedback%20on%20Main.WebHome)
  65
  66 - Simplified Copyright notice for the [[WebRss]] feed (don't use any special characters, html tags, entities, wiki markup or [[WikiWords]])
  67   - Set WEBRSSCOPYRIGHT = Copyright 2010 by contributing authors
  68
  69 - 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.
  70   - Set NOSEARCHALL =
  71 - Prevent automatic linking of [[WikiWords]] and acronyms (if set to `on`); link WikiWords (if empty); can be overwritten by web preferences:
  72   - Set NOAUTOLINK =
  73   - **_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.
  74 - 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:
  75   - Set HIDE\_NON\_WIKI\_WORD\_WARNINGS =
  76
  77 - Warn if `%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 `%INCLUDE{}%` :
  78   - Set INCLUDEWARNING = on
  79
  80 - Generated Table of Contents (TOC) settings
  81   - The first header level to appear in the TOC:
  82     - Set TOC\_MIN\_DEPTH =
  83       - If not set: `1`
  84       - Possible values: `1` to `6`
  85   - The last header level to appear in the TOC:
  86     - Set TOC\_MAX\_DEPTH =
  87       - If not set: `6`
  88       - Possible values: `1` to `6`
  89       - Can be overridden by `depth` parameter of [[variable TOC|SYSTEMWEB/VarTOC2]]
  90   - The default TOC title:
  91     - Set TOC\_TITLE =
  92       - If not set: nothing
  93       - Possible values: any string, for example `On this page:`
  94       - Can be overridden by `title` parameter of [[variable TOC|SYSTEMWEB/VarTOC2]]
  95   - Do not show a TOC if the topic it contains is included in another topic:
  96     - Set TOC\_HIDE\_IF\_INCLUDED =
  97       - If not set: included TOC is shown
  98       - Possible values: `on` or nothing
  99
 100 ## <a name="Default User Settings"></a> Default User Settings
 101
 102 %X% **NOTE:** They are typically redefined in topics of individual %USERSWEB%.TWikiUsers
 103
 104 - 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 WikiName, $wikiusername for %USERSWEB%.WikiName, $topic for the topic name, and $web for the web name
 105   - Set LINKTOOLTIPINFO = off
 106   - #Set LINKTOOLTIPINFO = $username - $date - $rev: $summary
 107
 108 - Horizontal size of text edit box: (can be overwritten by user preferences)
 109   - Set EDITBOXWIDTH = 70
 110
 111 - Vertical size of text edit box: (can be overwritten by user preferences)
 112   - Set EDITBOXHEIGHT = 22
 113
 114 - 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)
 115   - Set EDITBOXSTYLE = width:99%
 116
 117 - 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: (can be overwritten by user preferences)
 118   - Set FORCENEWREVISIONCHECKBOX =
 119
 120 - 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)
 121   - Set DONTNOTIFYCHECKBOX =
 122
 123 - 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)
 124   - Set ATTACHLINKBOX =
 125
 126 - Format of file link when the **_link_** check box is checked: (can be overwritten by user preferences)
 127   - %H% **NOTE:** Keyword <code>**$name**</code> gets expanded to filename; <code>**$comment**</code> to comment; <code>**\\t**</code> to tab (3 spaces for bullets).
 128
 129           * Set ATTACHEDFILELINKFORMAT = \n   * [[%ATTACHURL%/$name][$name]]: $comment
 130
 131 - Format of images when the **_link_** check box is checked: (can be overwritten by user preferences)
 132   - %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 and <code>**\\n**</code> to linefeed (3 spaces for bullets).
 133
 134           * Set ATTACHEDIMAGEFORMAT = \n   * $comment: <br />\n     <img src="%ATTACHURLPATH%/$name" alt="$name" $size />
 135
 136 ## <a name="TWiki Platform Settings"></a> TWiki Platform Settings
 137
 138 - TWiki site name:
 139   - Set WIKITOOLNAME = TWiki
 140
 141 - 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.
 142   - Set WIKILOGOIMG = ![T-logo-140x40-t.gif](http://www.dementia.org/twiki//view/%SYSTEMWEB%/TWikiLogos/T-logo-140x40-t.gif)
 143   - Set WIKILOGOURL = <http://TWiki.org/>
 144   - Set WIKILOGOALT = Powered by %WIKITOOLNAME%
 145
 146 - Home page of this site
 147   - Set WIKIHOMEURL = <http://www.dementia.org/twiki/view>
 148
 149 - List of %WIKITOOLNAME% webs - on the first line of the upper toolbar (to add a new web, see [[ManagingWebs]] and %SYSTEMWEB%.SiteMap):
 150   - Set WIKIWEBLIST = [[%USERSWEB%|USERSWEB/WebHome]] | [[%SYSTEMWEB%|SYSTEMWEB/WebHome]] | [[Sandbox|Sandbox/WebHome]]
 151   - %T% **NOTE:** To automatically list all non-hidden webs in alphabetical order, use the `%WEBLIST{}%` variable instead: <br />
 152
 153 - Maximum size of %SYSTEMWEB%.FileAttachments in KB, 0 for no limit:
 154   - Set ATTACHFILESIZELIMIT = 10000
 155
 156 - 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)
 157   - Set BROADCASTMESSAGE =
 158   - #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 %WIKITOOLNAME% maintenance.
 159
 160 - Users or groups allowed to [[create new top-level webs|SYSTEMWEB/ManagingWebs]]: (ex: %USERSWEB%.WebCreatorsGroup). If set to nothing, only administrators will be able to do this.
 161   - Set ALLOWROOTCHANGE = %USERSWEB%.TWikiAdminGroup
 162
 163 ### <a name="Search Settings"></a> Search Settings
 164
 165 - Default type for search, one of: keyword (for search engine like syntax), regex (for [[RegularExpression]] search), or literal (for verbatim search)
 166   - Set SEARCHDEFAULTTTYPE = keyword
 167 - Default for `%SEARCH{}%` variable, one of: keyword, regex, or literal
 168   - Set SEARCHVARDEFAULTTYPE = literal
 169 - Stop words, e.g., common words and characters to exclude from a keyword search:
 170   - 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
 171
 172 ### <a name="E-mail Settings"></a> E-mail Settings
 173
 174 - 'Mail this topic' mailto: link - can be included in topics, templates or skins
 175   - Set MAILTHISTOPIC = [%MAILTHISTOPICTEXT%](mailto:?subject=WebHome&body=%TOPICURL%)
 176
 177 - 'Mail this topic' link text
 178   - Set MAILTHISTOPICTEXT = Send a link to this page
 179
 180 - URL for current topic
 181   - Set TOPICURL = [[http://www.dementia.org/twiki/view/%WEB%/WebHome|%WEB%/WebHome]]
 182
 183 ### <a name="HTTP-EQUIV Settings"></a> HTTP-EQUIV Settings
 184
 185 - %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.
 186 - **NOTE:** The current values of these preferences are not displayed in view mode (values are `<link>`-tags).
 187
 188 - <code>**http-equiv**</code> meta tags for <code>**view**</code>, <code>**rdiff**</code>, <code>**attach**</code>, <code>**search\***</code> scripts:
 189   - #Set HTTP\_EQUIV\_ON\_VIEW =
 190   - Set HTTP\_EQUIV\_ON\_VIEW =
 191
 192 - <code>**http-equiv**</code> meta tags for <code>**edit**</code> script:
 193   - Set HTTP\_EQUIV\_ON\_EDIT =
 194
 195 - <code>**http-equiv**</code> meta tags for <code>**preview**</code> script:
 196   - Set HTTP\_EQUIV\_ON\_PREVIEW =
 197
 198 ## <a name="Skin Settings"></a> Skin Settings
 199
 200 - Skin overriding the default TWiki templates: (can be overwritten by [[WebPreferences]] and user preferences)
 201   - Set SKIN = pattern
 202
 203 - **_Note:_** See [[TWikiSkinBrowser]] for currently installed skins
 204
 205 ### <a name="PatternSkin"></a> [[PatternSkin]]
 206
 207 - Default TWiki styles
 208   - Set TWIKILAYOUTURL = <http://www.dementia.org/twiki//view/%SYSTEMWEB%/PatternSkin/layout.css>
 209   - Set TWIKISTYLEURL = <http://www.dementia.org/twiki//view/%SYSTEMWEB%/PatternSkin/style.css>
 210   - Set TWIKICOLORSURL = <http://www.dementia.org/twiki//view/%SYSTEMWEB%/PatternSkin/colors.css>
 211
 212 - Custom overriding styles (enabled pr. default but empty, to prevent browsers from fetching %USERLAYOUTURL%-style URLs)
 213   - Set USERLAYOUTURL =
 214   - Set USERSTYLEURL =
 215   - Set USERCOLORSURL =
 216
 217 - **PatternSkin header settings**
 218   - Set WEBHEADERART = ![TWiki\_header.gif](http://www.dementia.org/twiki//view/%SYSTEMWEB%/PatternSkin/TWiki_header.gif)
 219   - #Set WEBHEADERBGCOLOR = #faf8f0
 220
 221 ### <a name="Skin icons"></a> Skin icons
 222
 223 - Topic containing the icon graphics library. Icons can easily be rendered with `%ICON{name}%`.
 224   - Set ICONTOPIC = %SYSTEMWEB%.TWikiDocGraphics
 225
 226 ### <a name="Legacy support"></a> Legacy support
 227
 228 - Support for legacy "EDITTOPIC", used to be hard-coded, now replaced by TMPL:P conditional instantiation
 229   - Set EDITURL = <http://www.dementia.org/twiki/edit/%WEB%/%TOPIC%?t=1277827909>
 230   - Set EDITTOPIC = [Edit](%EDITURL% Edit Topic - deprecated usage - please see release notes)
 231
 232 ## <a name="Plugins Settings"></a> Plugins Settings
 233
 234 - You can enable/disable Plugins using the [configure](http://www.dementia.org/twiki/configure) interface.
 235 - You can also disable installed plugins in individual webs/topics by defining the %DISABLEDPLUGINS% TWiki variable to be a list of plugins to disable e.g.
 236   - Set DISABLEDPLUGINS = [[SpreadSheetPlugin]],EditTablePlugin
 237   - Currently, %DISABLEDPLUGINS% is set to "%DISABLEDPLUGINS%"
 238 - Currently activated Plugins: [[SpreadSheetPlugin]], [[CommentPlugin]], [[EditTablePlugin]], [[InterwikiPlugin]], [[PreferencesPlugin]], [[SlideShowPlugin]], [[SmiliesPlugin]], [[TablePlugin]], [[TwistyPlugin]]
 239
 240 - %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]].
 241 - Detailed diagnostics can be found in [[InstalledPlugins]]
 242 - Legacy settings:
 243   - 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.
 244
 245 <a name="RenderingShortcuts"></a>
 246
 247 ## <a name="Rendering Shortcuts Settings"></a> Rendering Shortcuts Settings
 248
 249 - Line break: Note that the setting has an intentional trailing space
 250   - Set BR = <br />
 251
 252 - Bullet sign:
 253   - Set BULLET = •
 254
 255 - Vertical bar / pipe symbol:
 256   - Set VBAR = |
 257
 258 - Vertical caret symbol:
 259   - Set CARET = ^
 260
 261 - Line break and bullet with different levels of indentation:
 262   - Set BB = <br />•
 263   - Set BB2 = <br />  •
 264   - Set BB3 = <br />    •
 265   - Set BB4 = <br />      •
 266
 267 - **_Hint:_** Above shortcuts are useful in TWiki tables where you cannot use newlines
 268
 269 <a name="DocGraphics"></a>
 270
 271 - 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.)_:
 272   - Set H = <img src="http://www.dementia.org/twiki//view/Main/WebHome/help.gif" width="16" height="16" alt="HELP" title="HELP" />
 273   - Set I = <img src="http://www.dementia.org/twiki//view/Main/WebHome/tip.gif" width="16" height="16" alt="IDEA!" title="IDEA!" />
 274   - Set M = <img src="http://www.dementia.org/twiki//view/Main/WebHome/arrowright.gif" width="16" height="16" alt="MOVED TO..." title="MOVED TO..." />
 275   - Set N = <img src="http://www.dementia.org/twiki//view/Main/WebHome/new.gif" width="30" height="16" alt="NEW" title="NEW" />
 276   - Set P = <img src="http://www.dementia.org/twiki//view/Main/WebHome/pencil.gif" width="16" height="16" alt="REFACTOR" title="REFACTOR" />
 277   - Set Q = <img src="http://www.dementia.org/twiki//view/Main/WebHome/help.gif" width="16" height="16" alt="QUESTION?" title="QUESTION?" />
 278   - Set S = <img src="http://www.dementia.org/twiki//view/Main/WebHome/starred.gif" width="16" height="16" alt="PICK" title="PICK" />
 279   - Set T = <img src="http://www.dementia.org/twiki//view/Main/WebHome/tip.gif" width="16" height="16" alt="TIP" title="TIP" />
 280   - Set U = <img src="http://www.dementia.org/twiki//view/Main/WebHome/updated.gif" width="55" height="16" alt="UPDATED" title="UPDATED" />
 281   - Set X = <img src="http://www.dementia.org/twiki//view/Main/WebHome/warning.gif" width="16" height="16" alt="ALERT!" title="ALERT!" />
 282   - Set Y = <img src="http://www.dementia.org/twiki//view/Main/WebHome/choice-yes.gif" width="16" height="16" alt="DONE" title="DONE" />
 283
 284 - Colored text: (see more [[StandardColors]]) <table border="1" cellpadding="0" cellspacing="0">
 285   <tr>
 286     <td> You type: </td>
 287     <td><code>%RED% red text %ENDCOLOR% and %GREEN% green text %ENDCOLOR%</code></td>
 288   </tr>
 289   <tr>
 290     <td> You get: </td>
 291     <td> %RED% red text %ENDCOLOR% and %GREEN% green text %ENDCOLOR% </td>
 292   </tr>
 293 </table>
 294   - **_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%`.
 295   - %YELLOW% **Set YELLOW = looks like this** %ENDCOLOR%
 296   - %ORANGE% **Set ORANGE = looks like this** %ENDCOLOR%
 297   - %RED% **Set RED = looks like this** %ENDCOLOR%
 298   - %PINK% **Set PINK = looks like this** %ENDCOLOR%
 299   - %PURPLE% **Set PURPLE = looks like this** %ENDCOLOR%
 300   - %TEAL% **Set TEAL = looks like this** %ENDCOLOR%
 301   - %NAVY% **Set NAVY = looks like this** %ENDCOLOR%
 302   - %BLUE% **Set BLUE = looks like this** %ENDCOLOR%
 303   - %AQUA% **Set AQUA = looks like this** %ENDCOLOR%
 304   - %LIME% **Set LIME = looks like this** %ENDCOLOR%
 305   - %GREEN% **Set GREEN = looks like this** %ENDCOLOR%
 306   - %OLIVE% **Set OLIVE = looks like this** %ENDCOLOR%
 307   - %MAROON% **Set MAROON = looks like this** %ENDCOLOR%
 308   - %BROWN% **Set BROWN = looks like this** %ENDCOLOR%
 309   - %BLACK% **Set BLACK = looks like this** %ENDCOLOR%
 310   - %GRAY% **Set GRAY = looks like this** %ENDCOLOR%
 311   - %SILVER% **Set SILVER = looks like this** %ENDCOLOR%
 312   - <span>%WHITE% **Set WHITE = looks like this (with gray background)** %ENDCOLOR%</span>
 313   - The following color settings are enclosed in verbatim tags to avoid incorrect nesting of XHTML tags:
 314
 315           * Set YELLOW = <font color="#ffff00">
 316           * Set ORANGE = <font color="#ff6600">
 317           * Set RED = <font color="#ff0000">
 318           * Set PINK = <font color="#ff00ff">
 319           * Set PURPLE = <font color="#800080">
 320           * Set TEAL = <font color="#008080">
 321           * Set NAVY = <font color="#000080">
 322           * Set BLUE = <font color="#0000ff">
 323           * Set AQUA = <font color="#00ffff">
 324           * Set LIME = <font color="#00ff00">
 325           * Set GREEN = <font color="#008000">
 326           * Set OLIVE = <font color="#808000">
 327           * Set MAROON = <font color="#800000">
 328           * Set BROWN = <font color="#996633">
 329           * Set BLACK = <font color="#000000">
 330           * Set GRAY = <font color="#808080">
 331           * Set SILVER = <font color="#c0c0c0">
 332           * Set WHITE = <font color="#ffffff">
 333           * Set ENDCOLOR = </font>
 334
 335 ## <a name="Miscellaneous Settings"></a> Miscellaneous Settings
 336
 337 - Format of a [[NewWikiWord]] link:
 338 - Note that `$text` is the topic link text, `$topic` is the name of the new topic, and `$web` is the name of the web for the new topic. Values for the 3 are taken from the link syntax `[[$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`.
 339   - default setting:
 340     - Set NEWLINKFORMAT = <span>$text[?](http://www.dementia.org/twiki/edit/$web/$topic?topicparent=%WEB%.%TOPIC% Create this topic)</span>
 341   - alternative setting:
 342     - #Set NEWLINKFORMAT = [$text](http://www.dementia.org/twiki/edit/$web/$topic?topicparent=%WEB%.%TOPIC% Create this topic)
 343
 344 - %SYSTEMWEB%.PreviewBackground image:
 345   - Set PREVIEWBGIMAGE = ![preview2bg.gif](http://www.dementia.org/twiki//view/%SYSTEMWEB%/PreviewBackground/preview2bg.gif)
 346
 347 - User-friendly synonyms for system webs
 348   - Set DOCWEB = %SYSTEMWEB%
 349
 350 - show extra help for ApacheLogin users for [[TWikiAdminUser]] login
 351   - Set ADMINLOGIN = [internal admin login](http://www.dementia.org/twiki/login?sudo=sudo;origurl=http://www.dementia.org/twiki/view/Main/WebHome) (use the username suggested and the password set in configure).
 352
 353 ## <a name="Access Control Settings"></a> Access Control Settings
 354
 355 - No-one (except admins) should change this topic
 356   - Set ALLOWTOPICCHANGE = %USERSWEB%.TWikiAdminGroup
 357   - Set ALLOWTOPICRENAME = %USERSWEB%.TWikiAdminGroup
 358
 359 ## <a name="Creating New Preference Variable"></a> Creating New Preference Variables
 360
 361 You can introduce new VARIABLES and use them in your topics and templates. There is no need to change the TWiki engine (Perl scripts).
 362
 363 - 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):
 364   - Set WEBBGCOLOR = #FFFFC0
 365 - Preferences are used as %SYSTEMWEB%.TWikiVariables by enclosing the name in percent signs: <code>**%**</code>. Example:
 366   - When you write variable <code>**%WEBBGCOLOR%**</code>, it gets expanded to `%WEBBGCOLOR%` .
 367
 368 - %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.
 369 - %X% In order to protect your custom variables from being overwritten when upgrading the [[%SYSTEMWEB%.%TOPIC%|SYSTEMWEB/TOPIC]] topic, it is recommended that custom variables are defined in [[%USERSWEB%.%TOPIC%|USERSWEB/TOPIC]].
 370
 371 ## <a name="Protected System Settings"></a> Protected System Settings
 372
 373 The following settings are declared final to protect them as read only. These are system variables that should never be attempted set or altered in any preference topic or topic settings.
 374
 375 - Set FINALPREFERENCES = WEB, TOPIC
 376
 377 ## <a name="Related Topics"></a> Related Topics
 378
 379 - [[WebPreferences]] has preferences of the %WEB% web.
 380 - User topics in %USERSWEB% can have optional user preferences.
 381 - %SYSTEMWEB%.TWikiVariables has a list of common `%VARIABLES%`.
 382 - %SYSTEMWEB%.TWikiAccessControl explains how to restrict access by users or groups.
 383 - TWiki:Plugins.PreferencesPlugin makes editing preferences a snap.
 384
 385 **_Note_**: Can't edit? [[View raw topic|%WEB%/%TOPIC%?raw=on]]