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