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), **_topic level_** (the topic being rendered), 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="#Default Web Preferences"> Default Web Preferences</a></li>
  10     <li><a href="#Default User Settings"> Default User Settings</a></li>
  11     <li><a href="#TWiki Platform Settings"> TWiki Platform Settings</a><ul>
  12         <li><a href="#Search Settings"> Search Settings</a></li>
  13         <li><a href="#Email and Proxy Server Settings"> Email and Proxy Server Settings</a></li>
  14         <li><a href="#Email Link Settings"> Email Link Settings</a></li>
  15         <li><a href="#HTTP-EQUIV Settings"> HTTP-EQUIV Settings</a></li>
  16       </ul>
  17     </li>
  18     <li><a href="#Skin Settings"> Skin Settings</a><ul>
  19         <li><a href="#PatternSkin"> PatternSkin</a></li>
  20         <li><a href="#DragonSkin"> DragonSkin</a></li>
  21       </ul>
  22     </li>
  23     <li><a href="#Plugins Settings"> Plugins Settings</a></li>
  24     <li><a href="#Miscellaneous Settings"> Miscellaneous Settings</a></li>
  25     <li><a href="#Access Control Settings"> Access Control Settings</a></li>
  26     <li><a href="#Preferences Control Settings"> Preferences Control Settings</a></li>
  27     <li><a href="#Creating New Preference Variable"> Creating New Preference Variables</a></li>
  28     <li><a href="#Related Topics"> Related Topics</a></li>
  29   </ul>
  30 </div>
  31
  32 ## <a name="Default Web Preferences"></a> Default Web Preferences
  33
  34 %X% **NOTE:** They are typically redefined in individual WebPreferences topics
  35
  36 - List of selected topics in a web - the second line of the upper toolbar (usually overwritten in individual [[WebPreferences]]):
  37   - Set WEBTOPICLIST = [[Changes|Main/WebChanges]] | [[Index|Main/WebIndex]] | [[Search|Main/WebSearch]] | Go <input name="topic" size="16" type="text" />
  38
  39 - Web specific background color: (is overwritten by web preferences)
  40   - Set WEBBGCOLOR = #C0C0C0
  41
  42 - Copyright notice:
  43   - Set WEBCOPYRIGHT = <font>Copyright © 1999-2010 by the contributing authors. \\nAll material on this collaboration platform is the property of the contributing authors. <br /> \\nIdeas, requests, problems regarding %WIKITOOLNAME%? [Send feedback](mailto:?subject=%WIKITOOLNAME% Feedback on %WEB%.%TOPIC%). </font>
  44
  45 - Simplified Copyright notice for the [[WebRss]] feed (don't use any special characters or xml tags
  46   - Set WEBRSSCOPYRIGHT = Copyright 2010 by contributing authors
  47
  48 - Exclude web from a `web="all"` search: (Set to `on` for hidden webs; is overwritten by web preferences)
  49   - Set NOSEARCHALL =
  50
  51 - Prevent automatic linking of [[WikiWords]] and acronyms (if set to `on`); link WikiWords (if empty); can be overwritten by web preferences:
  52   - Set NOAUTOLINK =
  53   - **_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.
  54
  55 - 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{}%` :
  56   - Set INCLUDEWARNING = %RED% **_Note:_** %ENDCOLOR% Included topic [[$topic|Main/Topic]] does not exist yet
  57
  58 ## <a name="Default User Settings"></a> Default User Settings
  59
  60 %X% **NOTE:** They are typically redefined in topics of individual [[TWikiUsers]]
  61
  62 - 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 Main.WikiName, $topic for the topic name, and $web for the web name
  63   - Set LINKTOOLTIPINFO = on
  64   - #Set LINKTOOLTIPINFO = $username - $date - $rev: $summary
  65
  66 - Horizontal size of text edit box: (can be overwritten by user preferences)
  67   - Set EDITBOXWIDTH = 70
  68
  69 - Vertical size of text edit box: (can be overwritten by user preferences)
  70   - Set EDITBOXHEIGHT = 15
  71
  72 - 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)
  73   - Set EDITBOXSTYLE = width: 99%
  74
  75 - 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)
  76   - Set RELEASEEDITLOCKCHECKBOX =
  77
  78 - 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)
  79   - Set DONTNOTIFYCHECKBOX =
  80
  81 - 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)
  82   - Set ATTACHLINKBOX =
  83
  84 - Format of file link when the **_link_** check box is checked: (can be overwritten by user preferences)
  85   - %H% **NOTE:** Keyword <code>**$name**</code> gets expanded to filename; <code>**$comment**</code> to comment; <code>**\\t**</code> to tab (3 spaces for bullets).
  86   - Set ATTACHEDFILELINKFORMAT = \\t\* [$name](http://www.dementia.org/twiki//view/$name): $comment
  87
  88 - Format of images when the **_link_** check box is checked: (can be overwritten by user preferences)
  89   - %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).
  90
  91           * Set ATTACHEDIMAGEFORMAT = \t* $comment: <br />
  92             <img src="%ATTACHURLPATH%/$name" alt="$comment" $size />
  93
  94 ## <a name="TWiki Platform Settings"></a> TWiki Platform Settings
  95
  96 - TWiki site name:
  97   - Set WIKITOOLNAME = TWikibeta
  98
  99 - Image, URL and alternate tooltip text of TWiki logo: (can be overwritten by web preferences)
 100   - Set WIKILOGOIMG = ![twikiRobot46x50.gif](http://www.dementia.org/twiki//view/TWiki/TWikiLogos/twikiRobot46x50.gif)
 101   - Set WIKILOGOURL = <http://TWiki.org/>
 102   - Set WIKILOGOALT = TWiki home
 103
 104 - List of %WIKITOOLNAME% webs - on the first line of the upper toolbar (to add a new web, see [[ManagingWebs]] and [[SiteMap]]):
 105   - Set WIKIWEBLIST = [[Main|Main/WebHome]] | [[TWiki|TWiki/WebHome]] | [[Sandbox|Sandbox/WebHome]]
 106   - %T% **NOTE:** To automatically list all non-hidden webs in alphabetical order, use the `%WEBLIST{}%` variable instead: <br />
 107
 108 - Maximum size of [[FileAttachments]] in KB, 0 for no limit:
 109   - Set ATTACHFILESIZELIMIT = 10000
 110
 111 - 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)
 112   - Set BROADCASTMESSAGE =
 113   - #Set BROADCASTMESSAGE = <table border="0" cellpadding="3" cellspacing="0" width="100%">
 114   <tr>
 115     <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>
 116   </tr>
 117 </table>
 118
 119 ### <a name="Search Settings"></a> Search Settings
 120
 121 - Default type for search, one of: keyword (for search engine like syntax), regex (for [[RegularExpression]] search), or literal (for verbatim search)
 122   - Set SEARCHDEFAULTTTYPE = keyword
 123 - Default for `%SEARCH{}%` variable, one of: keyword, regex, or literal
 124   - Set SEARCHVARDEFAULTTYPE = literal
 125 - Stop words, e.g., common words and characters to exclude from a keyword search:
 126   - 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
 127
 128 ### <a name="Email and Proxy Server Settings"></a> Email and Proxy Server Settings
 129
 130 - TWiki webmaster email address:
 131   - Set WIKIWEBMASTER = <webmaster@your.company>
 132
 133 - TWiki webmaster name (first name and last name, e.g. `Fred Smith`):
 134   - Set WIKIWEBMASTERNAME = TWiki Administrator
 135
 136 - 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>
 137   - Set SMTPMAILHOST = mail
 138
 139 - 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>
 140   - Set SMTPSENDERHOST =
 141
 142 - 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.
 143   - Set PROXYHOST =
 144   - Set PROXYPORT =
 145
 146 ### <a name="Email Link Settings"></a> Email Link Settings
 147
 148 - 'Mail this topic' mailto: link - can be included in topics, templates or skins
 149   - Set MAILTHISTOPIC = [%MAILTHISTOPICTEXT%](mailto:?subject=WebHome&amp;body=%TOPICURL%)
 150
 151 - 'Mail this topic' link text
 152   - Set MAILTHISTOPICTEXT = Send a link to this page
 153
 154 - URL for current topic
 155   - Set TOPICURL = <http://www.dementia.org/twiki//view/%WEB%/WebHome>
 156
 157 ### <a name="HTTP-EQUIV Settings"></a> HTTP-EQUIV Settings
 158
 159 - %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.
 160
 161 - <code>**http-equiv**</code> meta tags for <code>**view**</code>, <code>**rdiff**</code>, <code>**attach**</code>, <code>**search\***</code> scripts:
 162
 163           * #Set HTTP_EQUIV_ON_VIEW =
 164           * Set HTTP_EQUIV_ON_VIEW =  <link rel="alternate" type="application/rss+xml" title="RSS Feed" href="%SCRIPTURL%/view%SCRIPTSUFFIX%/%WEB%/WebRss?skin=rss&amp;contenttype=text/xml" />
 165
 166 - <code>**http-equiv**</code> meta tags for <code>**edit**</code> script:
 167
 168           * Set HTTP_EQUIV_ON_EDIT =
 169
 170 - <code>**http-equiv**</code> meta tags for <code>**preview**</code> script:
 171
 172           * Set HTTP_EQUIV_ON_PREVIEW =
 173
 174 ## <a name="Skin Settings"></a> Skin Settings
 175
 176 - Skin overriding the default TWiki templates: (can be overwritten by [[WebPreferences]] and user preferences)
 177   - #Set SKIN = pattern
 178
 179 - **_Note:_** See [[TWikiSkinBrowser]] for currently installed skins
 180
 181 ### <a name="PatternSkin"></a> [[PatternSkin]]
 182
 183 - Using attachments for styles
 184   - #Set TWIKILAYOUTURL = <http://www.dementia.org/twiki//view/TWiki/PatternSkin/layout.css>
 185   - #Set TWIKISTYLEURL = <http://www.dementia.org/twiki//view/TWiki/PatternSkin/style.css>
 186
 187 - Using topics to define styles - these settings will override attachment style settings above -
 188   - Default TWiki CSS styling topics where layout and style are are defined:
 189     - #Set TWIKILAYOUTTOPIC = [[TWikiLayout]]
 190     - #Set TWIKISTYLETOPIC = [[TWikiStyle]]
 191   - CSS styling topics to be defined in local webs or in user topics (these can complement or override default TWiki style topics):
 192     - Set LAYOUTTOPIC =
 193     - Set STYLETOPIC =
 194   - Use the CSS TOPIC setting above to build the URLS used in the templates
 195     - #Set TWIKILAYOUTURL = ..//%TWIKILAYOUTTOPIC%?skin=text&amp;contenttype=text/css
 196     - #Set TWIKISTYLEURL = ..//%TWIKISTYLETOPIC%?skin=text&amp;contenttype=text/css
 197     - #Set USERLAYOUTURL = ..//%USERLAYOUTTOPIC%?skin=text&amp;contenttype=text/css
 198     - #Set USERSTYLEURL = ..//%USERSTYLETOPIC%?skin=text&amp;contenttype=text/css
 199
 200 ### <a name="DragonSkin"></a> [[DragonSkin]]
 201
 202 - Theme: (gray, monochrome, tabstyle)
 203   - Set DS\_THEME = gray
 204 - Quicklinks headings:
 205   - Set DS\_QUICKLINKSHEADING =
 206 - Quicklinks submenu:
 207   - Set DS\_QUICKLINKS =
 208
 209 ## <a name="Plugins Settings"></a> Plugins Settings
 210
 211 - [[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.
 212   - Set INSTALLEDPLUGINS = [[DefaultPlugin]], [[SpreadSheetPlugin]]
 213   - Set DISABLEDPLUGINS = [[EmptyPlugin]]
 214   - Currently activated plugins: [[SpreadSheetPlugin]], [[CommentPlugin]], [[EditTablePlugin]], [[InterwikiPlugin]], [[PreferencesPlugin]], [[SlideShowPlugin]], [[SmiliesPlugin]], [[TablePlugin]], [[TwistyPlugin]]
 215   - %T% **NOTE:** You can enable/disable all plugins with the <code>**$disableAllPlugins**</code> flag in the <code>**lib/TWiki.cfg**</code> file.
 216
 217 ## <a name="Miscellaneous Settings"></a> Miscellaneous Settings
 218
 219 - Line break:
 220   - Set BR = <br />
 221
 222 - Bullet sign:
 223   - Set BULLET = •
 224
 225 - Line break and bullet with different levels of indentation:
 226   - Set BB = <br />•
 227   - Set BB2 = <br />  •
 228   - Set BB3 = <br />    •
 229   - Set BB4 = <br />      •
 230
 231 - Colored text: (see more [[StandardColors]]) <table border="1" cellpadding="0" cellspacing="0">
 232   <tr>
 233     <td> You type: </td>
 234     <td><code>%RED% red text %ENDCOLOR% and %GREEN% green text %ENDCOLOR%</code></td>
 235   </tr>
 236   <tr>
 237     <td> You get: </td>
 238     <td> %RED% red text %ENDCOLOR% and %GREEN% green text %ENDCOLOR% </td>
 239   </tr>
 240 </table>
 241   - **_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%`.
 242   - %YELLOW% **Set YELLOW = looks like this** %ENDCOLOR%
 243   - %ORANGE% **Set ORANGE = looks like this** %ENDCOLOR%
 244   - %RED% **Set RED = looks like this** %ENDCOLOR%
 245   - %PINK% **Set PINK = looks like this** %ENDCOLOR%
 246   - %PURPLE% **Set PURPLE = looks like this** %ENDCOLOR%
 247   - %TEAL% **Set TEAL = looks like this** %ENDCOLOR%
 248   - %NAVY% **Set NAVY = looks like this** %ENDCOLOR%
 249   - %BLUE% **Set BLUE = looks like this** %ENDCOLOR%
 250   - %AQUA% **Set AQUA = looks like this** %ENDCOLOR%
 251   - %LIME% **Set LIME = looks like this** %ENDCOLOR%
 252   - %GREEN% **Set GREEN = looks like this** %ENDCOLOR%
 253   - %OLIVE% **Set OLIVE = looks like this** %ENDCOLOR%
 254   - %MAROON% **Set MAROON = looks like this** %ENDCOLOR%
 255   - %BROWN% **Set BROWN = looks like this** %ENDCOLOR%
 256   - %BLACK% **Set BLACK = looks like this** %ENDCOLOR%
 257   - %GRAY% **Set GRAY = looks like this** %ENDCOLOR%
 258   - %SILVER% **Set SILVER = looks like this** %ENDCOLOR%
 259   - <span>%WHITE% **Set WHITE = looks like this (with gray background)** %ENDCOLOR%</span>
 260   - The following color settings are enclosed in verbatim tags to avoid incorrect nesting of XHTML tags:
 261
 262           * Set YELLOW = <font color="#ffff00">
 263           * Set ORANGE = <font color="#ff6600">
 264           * Set RED = <font color="#ff0000">
 265           * Set PINK = <font color="#ff00ff">
 266           * Set PURPLE = <font color="#800080">
 267           * Set TEAL = <font color="#008080">
 268           * Set NAVY = <font color="#000080">
 269           * Set BLUE = <font color="#0000ff">
 270           * Set AQUA = <font color="#00ffff">
 271           * Set LIME = <font color="#00ff00">
 272           * Set GREEN = <font color="#008000">
 273           * Set OLIVE = <font color="#808000">
 274           * Set MAROON = <font color="#800000">
 275           * Set BROWN = <font color="#996633">
 276           * Set BLACK = <font color="#000000">
 277           * Set GRAY = <font color="#808080">
 278           * Set SILVER = <font color="#c0c0c0">
 279           * Set WHITE = <font color="#ffffff">
 280           * Set ENDCOLOR = </font>
 281
 282 <a name="DocGraphics"></a>
 283
 284 - 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.)_:
 285   - Set H = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/help.gif" width="16" height="16" alt="HELP" />
 286   - Set I = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/tip.gif" width="16" height="16" alt="IDEA!" />
 287   - Set M = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/arrowright.gif" width="16" height="16" alt="MOVED TO..." />
 288   - Set N = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/new.gif" width="28" height="8" alt="NEW" />
 289   - Set P = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/pencil.gif" width="16" height="16" alt="REFACTOR" />
 290   - Set Q = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/help.gif" width="16" height="16" alt="QUESTION?" />
 291   - Set S = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/starred.gif" width="16" height="16" alt="PICK" />
 292   - Set T = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/tip.gif" width="16" height="16" alt="TIP" />
 293   - Set U = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/updated.gif" width="56" height="8" alt="UPDATED" />
 294   - Set X = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/warning.gif" width="16" height="16" alt="ALERT!" />
 295   - Set Y = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/choice-yes.gif" width="16" height="16" alt="DONE" />
 296
 297 - Background color of non existing topic: ( default `cornsilk` or `#FFFFCE` )
 298   - Set NEWTOPICBGCOLOR = #FFFFCE
 299
 300 - Font color of non existing topic: ( default `#0000FF` )
 301   - Set NEWTOPICFONTCOLOR = #0000FF
 302
 303 - [[PreviewBackground]] image:
 304   - Set PREVIEWBGIMAGE = ![preview2bg.gif](http://www.dementia.org/twiki//view/TWiki/PreviewBackground/preview2bg.gif)
 305
 306 ## <a name="Access Control Settings"></a> Access Control Settings
 307
 308 - Users or groups allowed to change or rename this %TOPIC% topic: (ex: [[TWikiAdminGroup]])
 309   - Set ALLOWTOPICCHANGE =
 310   - Set ALLOWTOPICRENAME = [[TWikiAdminGroup]]
 311
 312 - Users or groups allowed to [[create new webs|TWiki/ManagingWebs]]: (ex: [[TWikiAdminGroup]])
 313   - Set ALLOWWEBMANAGE = [[TWikiAdminGroup]]
 314
 315 ## <a name="Preferences Control Settings"></a> Preferences Control Settings
 316
 317 - Allow topic level preferences, on or off: If set to `on`, topic preferences will be read, and will override any web- or site-level preferences not set as `FINALPREFERENCES`. By default, user preferences will override topic preferences.
 318   - Set READTOPICPREFS = on
 319
 320 - Topic level overrides user level preferences, on or off: If set to `on`, topic preferences will override user preferences. The user can in turn override this behavior by setting further `FINALPREFERENCES` in his or her user topic.
 321   - Set TOPICOVERRIDESUSER = off
 322
 323 - Site-level preferences that are **not** allowed to be overridden by [[WebPreferences]] and user preferences:
 324   - Set FINALPREFERENCES = ATTACHFILESIZELIMIT, PREVIEWBGIMAGE, WIKITOOLNAME, WIKIWEBMASTER, SMTPMAILHOST, SMTPSENDERHOST, ALLOWWEBMANAGE, READTOPICPREFS, TOPICOVERRIDESUSER, BASICSTYLETOPIC
 325
 326 ## <a name="Creating New Preference Variable"></a> Creating New Preference Variables
 327
 328 You can introduce new VARIABLES and use them in your topics and templates. There is no need to change the TWiki engine (Perl scripts).
 329
 330 - 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):
 331   - Set WEBBGCOLOR = #FFFFC0
 332 - Preferences are used as [[TWikiVariables]] by enclosing the name in percent signs: <code>**%**</code>. Example:
 333   - When you write variable <code>**%WEBBGCOLOR%**</code>, it gets expanded to `%WEBBGCOLOR%` .
 334
 335 - %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.
 336
 337 ## <a name="Related Topics"></a> Related Topics
 338
 339 - [[WebPreferences]] has preferences of the %WIKITOOLNAME%.%WEB% web.
 340 - [[TWikiUsers]] has a list of user topics. User topics can have optional user preferences.
 341 - [[TWikiVariables]] has a list of common `%VARIABLES%`.
 342 - [[TWikiAccessControl]] explains how to restrict access by users or groups.
 343
 344 **_Note_**: Can't edit? [View raw topic](http://www.dementia.org/twiki//view/%WEB%/%TOPIC%?raw=on)