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