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