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), 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="#Web Preferences"> Web Preferences</a></li>
  10     <li><a href="#User Settings"> User Settings</a></li>
  11     <li><a href="#TWiki Platform Settings"> TWiki Platform Settings</a></li>
  12     <li><a href="#Email and Proxy Server Settings"> Email and Proxy Server Settings</a><ul>
  13         <li><a href="#Email Link Settings"> Email Link Settings</a></li>
  14       </ul>
  15     </li>
  16     <li><a href="#Plugins Settings"> Plugins Settings</a></li>
  17     <li><a href="#HTTP-EQUIV Settings"> HTTP-EQUIV Settings</a></li>
  18     <li><a href="#Miscellaneous Settings"> Miscellaneous Settings</a></li>
  19     <li><a href="#Access Control Settings"> Access Control Settings</a></li>
  20     <li><a href="#Creating New Preference Variable"> Creating New Preference Variables</a></li>
  21     <li><a href="#Related Topics"> Related Topics</a></li>
  22   </ul>
  23 </div>
  24
  25 ## <a name="Web Preferences"></a> Web Preferences
  26
  27 %X% **NOTE:** They are typically redefined in individual WebPreferences topics
  28
  29 - List of selected topics in a web - the second line of the upper toolbar (usually overwritten in individual [[WebPreferences]]):
  30   - Set WEBTOPICLIST = [[Changes|Main/WebChanges]] | [[Index|Main/WebIndex]] | [[Search|Main/WebSearch]] | Go <input name="topic" size="16" type="text" />
  31
  32 - Copyright notice:
  33   - Set WEBCOPYRIGHT = <font>Copyright © 1999-2002 by the contributing authors. \\nAll material on this collaboration tool is the property of the contributing authors. <br /> \\nIdeas, requests, problems regarding %WIKITOOLNAME%? [Send](mailto:?subject=%WIKITOOLNAME% Feedback) feedback. </font>
  34
  35 - Exclude web from a `web="all"` search: (Set to `on` for hidden webs; is overwritten by web preferences)
  36   - Set NOSEARCHALL =
  37
  38 - Web specific background color: (is overwritten by web preferences)
  39   - Set WEBBGCOLOR = #C0C0C0
  40
  41 ## <a name="User Settings"></a> User Settings
  42
  43 %X% **NOTE:** They are typically redefined in topics of individual [[TWikiUsers]]
  44
  45 - Horizontal size of text edit box: (can be overwritten by user preferences)
  46   - Set EDITBOXWIDTH = 70
  47
  48 - Vertical size of text edit box: (can be overwritten by user preferences)
  49   - Set EDITBOXHEIGHT = 15
  50
  51 - 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)
  52   - Set EDITBOXSTYLE = width: 99%
  53
  54 - 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)
  55   - Set RELEASEEDITLOCKCHECKBOX =
  56
  57 - 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)
  58   - Set DONTNOTIFYCHECKBOX =
  59
  60 - 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)
  61   - Set ATTACHLINKBOX =
  62
  63 - Format of file link when the **_link_** check box is checked: (can be overwritten by user preferences)
  64   - %H% **NOTE:** Keyword <code>**$name**</code> gets expanded to filename; <code>**$comment**</code> to comment; <code>**\\t**</code> to tab (3 spaces for bullets).
  65   - Set ATTACHEDFILELINKFORMAT = \\t\* [$name](http://www.dementia.org/twiki//view/$name): $comment
  66
  67 - Format of images when the **_link_** check box is checked: (can be overwritten by user preferences)
  68   - %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).
  69
  70           * Set ATTACHEDIMAGEFORMAT = \t* $comment: <br />
  71             <img src="%ATTACHURLPATH%/$name" alt="$name" $size />
  72
  73 ## <a name="TWiki Platform Settings"></a> TWiki Platform Settings
  74
  75 - TWiki platform name:
  76   - Set WIKITOOLNAME = TWikibeta
  77
  78 - Image, URL and alternate tooltip text of TWiki logo: (can be overwritten by web preferences)
  79   - Set WIKILOGOIMG = ![twikiRobot46x50.gif](http://www.dementia.org/twiki//view/TWiki/TWikiLogos/twikiRobot46x50.gif)
  80   - Set WIKILOGOURL = <http://TWiki.org/>
  81   - Set WIKILOGOALT = TWiki home
  82
  83 - List of %WIKITOOLNAME% webs - on the first line of the upper toolbar (to add a new web, see [[ManagingWebs]] and [[SiteMap]]):
  84   - Set WIKIWEBLIST = [[Main|Main/WebHome]] | [[TWiki|TWiki/WebHome]] | [[Know|Know/WebHome]] | [[Sandbox|Sandbox/WebHome]]
  85   - %T% **NOTE:** To automatically list all non-hidden webs in alphabetical order, use the `%WEBLIST{}%` variable instead: <br />
  86
  87 - Skin overriding the default TWiki templates: (can be overwritten by [[WebPreferences]] and user preferences)
  88   - Set SKIN =
  89
  90 ## <a name="Email and Proxy Server Settings"></a> Email and Proxy Server Settings
  91
  92 - TWiki webmaster email address:
  93   - Set WIKIWEBMASTER = <webmaster@your.company>
  94
  95 - 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>
  96   - Set SMTPMAILHOST = mail
  97
  98 - 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>
  99   - Set SMTPSENDERHOST =
 100
 101 - 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.
 102   - Set PROXYHOST =
 103   - Set PROXYPORT =
 104
 105 ### <a name="Email Link Settings"></a> Email Link Settings
 106
 107 - 'Mail this topic' mailto: link - can be included in topics, templates or skins
 108   - Set MAILTHISTOPIC = [%MAILTHISTOPICTEXT%](mailto:?subject=WebHome&amp;body=%TOPICURL%)
 109
 110 - 'Mail this topic' link text
 111   - Set MAILTHISTOPICTEXT = Send a link to this page
 112
 113 - URL for current topic
 114   - Set TOPICURL = <http://www.dementia.org/twiki//view/%WEB%/WebHome>
 115
 116 ## <a name="Plugins Settings"></a> Plugins Settings
 117
 118 - [[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.
 119   - Set INSTALLEDPLUGINS = [[DefaultPlugin]]
 120   - Set DISABLEDPLUGINS = [[EmptyPlugin]]
 121   - Currently activated plugins: [[SpreadSheetPlugin]], [[CommentPlugin]], [[EditTablePlugin]], [[InterwikiPlugin]], [[PreferencesPlugin]], [[SlideShowPlugin]], [[SmiliesPlugin]], [[TablePlugin]], [[TwistyPlugin]]
 122   - %T% **NOTE:** You can enable/disable all plugins with the <code>**$disableAllPlugins**</code> flag in the <code>**lib/TWiki.cfg**</code> file.
 123
 124 ## <a name="HTTP-EQUIV Settings"></a> HTTP-EQUIV Settings
 125
 126 - <code>**http-equiv**</code> meta tags for <code>**view**</code>, <code>**rdiff**</code>, <code>**attach**</code>, <code>**search\***</code> scripts:
 127
 128           * Set HTTP_EQUIV_ON_VIEW =
 129
 130 - <code>**http-equiv**</code> meta tags for <code>**edit**</code> script. Example, to expire immediately: <br />`Set HTTP_EQUIV_ON_EDIT = <meta http-equiv="Expires" content="%GMTIME{"$day $month $year $hour:$min:$sec"}% GMT">`
 131
 132           * Set HTTP_EQUIV_ON_EDIT =
 133
 134 - <code>**http-equiv**</code> meta tags for <code>**preview**</code> script:
 135
 136           * Set HTTP_EQUIV_ON_PREVIEW =
 137
 138 ## <a name="Miscellaneous Settings"></a> Miscellaneous Settings
 139
 140 - Line break:
 141   - Set BR = <br />
 142
 143 - Colored text: (see more [[StandardColors]]) <table border="1" cellpadding="0" cellspacing="0">
 144   <tr>
 145     <td> You type: </td>
 146     <td><code>%RED% red text %ENDCOLOR% and %GREEN% green text %ENDCOLOR%</code></td>
 147   </tr>
 148   <tr>
 149     <td> You get: </td>
 150     <td> %RED% red text %ENDCOLOR% and %GREEN% green text %ENDCOLOR% </td>
 151   </tr>
 152 </table>
 153   - **_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%`.
 154   - Set YELLOW = <font>
 155     - **YELLOW looks like this**</font>
 156 - Set ORANGE = <font>
 157   - **ORANGE looks like this**</font>
 158
 159 - Set RED = <font>
 160   - **RED looks like this**</font>
 161
 162 - Set PINK = <font>
 163   - **PINK looks like this**</font>
 164
 165 - Set PURPLE = <font>
 166   - **PURPLE looks like this**</font>
 167
 168 - Set TEAL = <font>
 169   - **TEAL looks like this**</font>
 170
 171 - Set NAVY = <font>
 172   - **NAVY looks like this**</font>
 173
 174 - Set BLUE = <font>
 175   - **BLUE looks like this**</font>
 176
 177 - Set AQUA = <font>
 178   - **AQUA looks like this**</font>
 179
 180 - Set LIME = <font>
 181   - **LIME looks like this**</font>
 182
 183 - Set GREEN = <font>
 184   - **GREEN looks like this**</font>
 185
 186 - Set OLIVE = <font>
 187   - **OLIVE looks like this**</font>
 188
 189 - Set MAROON = <font>
 190   - **MAROON looks like this**</font>
 191
 192 - Set BLACK = <font>
 193   - **BLACK looks like this**</font>
 194
 195 - Set GRAY = <font>
 196   - **GRAY looks like this**</font>
 197
 198 - Set SILVER = <font>
 199   - **SILVER looks like this**</font>
 200
 201 - Set WHITE = <font>
 202   - **WHITE looks like this**</font>
 203
 204 - And finally:<font> </font>
 205 - Set ENDCOLOR =
 206   - To finish colored text
 207
 208 - 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.)_:
 209   - Set H = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/help.gif" width="16" height="16" alt="HELP" />
 210   - Set I = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/tip.gif" width="16" height="16" alt="IDEA!" />
 211   - Set M = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/arrowright.gif" width="16" height="16" alt="MOVED TO..." />
 212   - Set N = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/new.gif" width="28" height="8" alt="NEW" />
 213   - Set P = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/pencil.gif" width="16" height="16" alt="REFACTOR" />
 214   - Set Q = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/help.gif" width="16" height="16" alt="QUESTION?" />
 215   - Set S = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/starred.gif" width="16" height="16" alt="PICK" />
 216   - Set T = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/tip.gif" width="16" height="16" alt="TIP" />
 217   - Set U = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/updated.gif" width="56" height="8" alt="UPDATED" />
 218   - Set X = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/warning.gif" width="16" height="16" alt="ALERT!" />
 219   - Set Y = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/choice-yes.gif" width="16" height="16" alt="DONE" />
 220
 221 - Background color of non existing topic: ( default `cornsilk` or `#FFFFCE` )
 222   - Set NEWTOPICBGCOLOR = #FFFFCE
 223
 224 - Font color of non existing topic: ( default `#0000FF` )
 225   - Set NEWTOPICFONTCOLOR = #0000FF
 226
 227 - [[PreviewBackground]] image:
 228   - Set PREVIEWBGIMAGE = ![previewbg.gif](http://www.dementia.org/twiki//view/TWiki/PreviewBackground/previewbg.gif)
 229
 230 ## <a name="Access Control Settings"></a> Access Control Settings
 231
 232 - Users or groups allowed to change or rename this %TOPIC% topic: (ex: [[TWikiAdminGroup]])
 233   - Set ALLOWTOPICCHANGE =
 234   - Set ALLOWTOPICRENAME =
 235
 236 - Users or groups allowed to [[create new webs|TWiki/ManagingWebs]]: (ex: [[TWikiAdminGroup]])
 237   - Set ALLOWWEBMANAGE = [[TWikiAdminGroup]]
 238
 239 - Site-level preferences that are **not** allowed to be overridden by [[WebPreferences]] and user preferences:
 240   - Set FINALPREFERENCES = PREVIEWBGIMAGE, WIKITOOLNAME, WIKIWEBMASTER, SMTPMAILHOST , SMTPSENDERHOST, ALLOWWEBMANAGE
 241
 242 ## <a name="Creating New Preference Variable"></a> Creating New Preference Variables
 243
 244 You can introduce new VARIABLES and use them in your topics and templates. There is no need to change the TWiki engine (Perl scripts).
 245
 246 - 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):
 247   - Set WEBBGCOLOR = #FFFFC0
 248 - Preferences are used as [[TWikiVariables]] by enclosing the name in percent signs: <code>**%**</code>. Example:
 249   - When you write variable <code>**%WEBBGCOLOR%**</code>, it gets expanded to `%WEBBGCOLOR%` .
 250
 251 - %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.
 252
 253 ## <a name="Related Topics"></a> Related Topics
 254
 255 - [[WebPreferences]] has preferences of the %WIKITOOLNAME%.%WEB% web.
 256 - [[TWikiUsers]] has a list of user topics. User topics can have optional user preferences.
 257 - [[TWikiVariables]] has a list of common `%VARIABLES%`.
 258 - [[TWikiAccessControl]] explains how to restrict access by users or groups.