TWiki/TWikiPreferences.mdwn

   1 **%WIKITOOLNAME% Site-Level Preferences**
   2
   3 The following settings are **_site-level preferences_** , e.g. affecting all users in all %WIKITOOLNAME% webs. These preferences can be overwritten by **_web preferences_** (topic [[WebPreferences]] in each %WIKITOOLNAME% web) and **_user preferences_** (your personal topic, i.e. [[TWikiGuest]] in the %WIKITOOLNAME%.Main web)
   4
   5 **_Preferences:_**
   6
   7 - List of %WIKITOOLNAME% webs: (the first line of a topic; to add a web see [[TWikiDocumentation]] and [[TWikiWebsTable]])
   8   - Set WIKIWEBLIST = [%WIKITOOLNAME%](%WIKIHOMEURL%) . \{ [Main](http://www.dementia.org/twiki//view/Main/WebHome) | [TWiki](http://www.dementia.org/twiki//view/TWiki/WebHome) | [Know](http://www.dementia.org/twiki//view/Know/WebHome) | [Test](http://www.dementia.org/twiki//view/Test/WebHome) \}
   9
  10 - List of topics of a web: (the second line of a topic, is overwritten by web preferences)
  11   - Set WEBTOPICLIST = %WEB% . \{ [Home](WebHome) | [Changes](WebChanges) | [Index](http://www.dementia.org/twiki//search/%WEB%/?scope=topic&regex=on&search=.*) | [Search](WebSearch) | Go <input name="topic" size="16" type="text" />
  12  \}
  13
  14 - Copyright notice:
  15   - Set WEBCOPYRIGHT = <font>Copyright © 2000 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>
  16
  17 - Exclude web from a `web="all"` search: (Set to `on` for hidden webs; is overwritten by web preferences)
  18   - Set NOSEARCHALL =
  19
  20 - Web specific background color: (is overwritten by web preferences)
  21   - Set WEBBGCOLOR = #C0C0C0
  22
  23 - [[PreviewBackground]] image:
  24   - Set PREVIEWBGIMAGE = ![previewbg.gif](http://www.dementia.org/twiki//view/TWiki/PreviewBackground/previewbg.gif)
  25
  26 - Background color of non existing topic: ( default `cornsilk` or `#FFFFCE` )
  27   - Set NEWTOPICBGCOLOR = #FFFFCE
  28
  29 - Font color of non existing topic: ( default `#0000FF` )
  30   - Set NEWTOPICFONTCOLOR = #0000FF
  31
  32 - Horizontal size of text edit box: (can be overwritten by user preferences)
  33   - Set EDITBOXWIDTH = 70
  34
  35 - Vertical size of text edit box: (can be overwritten by user preferences)
  36   - Set EDITBOXHEIGHT = 15
  37
  38 - Default state of the **_Release edit lock_** 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)
  39   - Set RELEASEEDITLOCKCHECKBOX =
  40
  41 - 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)
  42   - Set ATTACHLINKBOX =
  43
  44 - Wiki webmaster email address:
  45   - Set WIKIWEBMASTER = <webmaster@your.company>
  46
  47 - Mail host for outgoing mail. This is used for [[TWikiNotificationOfChanges]] if Perl module <code>**Net::SMTP**</code> is installed. If not, sendmail is used instead (defined by <code>**$mailProgram**</code> in <code>**TWiki.cfg**</code>). Examples: `mail.your.company` or `localhost`
  48   - Set SMTPMAILHOST = mail
  49
  50 - http-equiv meta tags for **_view_**, **_rdiff_**, **_attach_**, **_search\*_** scripts:
  51
  52           * Set HTTP_EQUIV_ON_VIEW =
  53
  54 - http-equiv meta tags for **_edit_** script. Example to expire immediately: <br />`Set HTTP_EQUIV_ON_EDIT = <meta http-equiv="Expires" content="%GMTIME{"$day $month, $year - $hour:$min:$sec"}% GMT">`
  55
  56           * Set HTTP_EQUIV_ON_EDIT =
  57
  58 - http-equiv meta tags for **_preview_** script:
  59
  60           * Set HTTP_EQUIV_ON_PREVIEW =
  61
  62 - Users or groups allowed to change this %TOPIC% topic: (I.e. [[TWikiAdminGroup]])
  63   - Set ALLOWTOPICCHANGE =
  64
  65 - Site-level preferences that are **not** allowed to be overridden by [[WebPreferences]] and user preferences:
  66   - Set FINALPREFERENCES = PREVIEWBGIMAGE, WIKIWEBMASTER, MAILHOST
  67
  68 **_Plugin Preferences:_**
  69
  70 - Installed [[TWikiPlugins]]: To enable/disable plugins, move them between ACTIVEPLUGINS and INACTIVEPLUGINS. Specify a comma separated list of plugin topics; the name of the web **_must_** be specified (i.e. <code>**TWiki.DefaultPlugin, TWiki.AnOtherPlugin**</code>)
  71   - Set ACTIVEPLUGINS = [[DefaultPlugin]]
  72   - Set INACTIVEPLUGINS = [[EmptyPlugin]]
  73
  74 - Preferences of [[DefaultPlugin]]:
  75   - Allow depreciated `%INCLUDE:"topic"%` syntax: (`0` or `1`)
  76     - Set DEFAULTPLUGIN\_OLDINCLUDE = 1
  77
  78 **_Notes:_**
  79
  80 - A preference is defined as: <br />`6 spaces * Set NAME = value`<br /> Example:
  81   - Set WEBBGCOLOR = #FFFFC0
  82 - Preferences are used as [[TWikiVariables]] by enclosing the name in percent signs. Example:
  83   - When you write variable `%WEBBGCOLOR%` , it gets expanded to `%WEBBGCOLOR%` .
  84 - The sequential order of the preference settings is significant. Define preferences that use other preferences first, i.e. set `WEBCOPYRIGHT` before `WIKIWEBMASTER` since `%WEBCOPYRIGHT%` uses the `%WIKIWEBMASTER%` variable.
  85 - You can introduce new variables and use them in your topics and templates. There is no need to change the %WIKITOOLNAME% engine (Perl scripts).
  86
  87 **_Related Topics:_**
  88
  89 - [[WebPreferences]] has preferences of the %WIKITOOLNAME%.%WEB% web.
  90 - [[TWikiUsers]] has a list of user topics. User topics can have optional user preferences.
  91 - [[TWikiVariables]] has a list of common `%VARIABLES%` .
  92 - [[TWikiAccessControl]] explains how to restrict access by users or groups.