**%WIKITOOLNAME% Site-Level Preferences**
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 %WEBPREFSTOPIC% in each %WIKITOOLNAME% web) and **_user preferences_** (your personal topic, i.e. [[Main/TWikiGuest]] in the %WIKITOOLNAME%.%MAINWEB% web)
**_Preferences:_**
* List of %WIKITOOLNAME% webs: (the first line of a topic; to add a web see [[TWikiDocumentation]] and [[TWikiWebsTable]])
* Set WIKIWEBLIST = [%WIKITOOLNAME%](%WIKIHOMEURL%) . \{ [Main](%SCRIPTURLPATH%/view%SCRIPTSUFFIX%/%MAINWEB%/%HOMETOPIC%) | [TWiki](%SCRIPTURLPATH%/view%SCRIPTSUFFIX%/%TWIKIWEB%/%HOMETOPIC%) | [Know](%SCRIPTURLPATH%/view%SCRIPTSUFFIX%/Know/%HOMETOPIC%) | [Test](%SCRIPTURLPATH%/view%SCRIPTSUFFIX%/Test/%HOMETOPIC%) \}
* List of topics of a web: (the second line of a topic, is overwritten by web preferences)
* Set WEBTOPICLIST = %WEB% . \{ [Home](%HOMETOPIC%) | [Changes](WebChanges) | [Index](%SCRIPTURLPATH%/search%SCRIPTSUFFIX%/%WEB%/?scope=topic®ex=on&search=.*) | [Search](WebSearch) | Go
\}
* Copyright notice:
* Set WEBCOPYRIGHT = Copyright © 2000 by the contributing authors. \\nAll material on this collaboration tool is the property of the contributing authors.
\\nIdeas, requests, problems regarding %WIKITOOLNAME%? [Send](mailto:%WIKIWEBMASTER%?subject=%WIKITOOLNAME% Feedback) feedback.
* Exclude web from a `web="all"` search: (Set to `on` for hidden webs; is overwritten by web preferences)
* Set NOSEARCHALL =
* Web specific background color: (is overwritten by web preferences)
* Set WEBBGCOLOR = #C0C0C0
* %TWIKIWEB%.PreviewBackground image:
* Set PREVIEWBGIMAGE = %PUBURLPATH%/%TWIKIWEB%/PreviewBackground/previewbg.gif
* Background color of non existing topic: ( default `cornsilk` or `#FFFFCE` )
* Set NEWTOPICBGCOLOR = #FFFFCE
* Font color of non existing topic: ( default `#0000FF` )
* Set NEWTOPICFONTCOLOR = #0000FF
* Horizontal size of text edit box: (can be overwritten by user preferences)
* Set EDITBOXWIDTH = 70
* Vertical size of text edit box: (can be overwritten by user preferences)
* Set EDITBOXHEIGHT = 15
* Default state of the **_link_** check box in the attach file page. Check box is initially checked if _Set ATTACHLINKBOX = CHECKED_ , 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)
* Set ATTACHLINKBOX =
* Wiki webmaster email address:
* Set WIKIWEBMASTER =
* Mail host for outgoing mail. This is used for [[TWikiNotificationOfChanges]] if Perl module **Net::SMTP**
is installed. If not, sendmail is used instead (defined by **$mailProgram**
in **TWiki.cfg**
). Examples: mail.your.company, localhost
* Set SMTPMAILHOST = mail
* http-equiv meta tags for **_view_**, **_rdiff_**, **_attach_**, **_search\*_** scripts:
* Set HTTP\_EQUIV\_ON\_VIEW =
* http-equiv meta tags for **_edit_** script. Example to expire immediately:
Set HTTP\_EQUIV\_ON\_EDIT = <meta http-equiv="Expires" content="%GMTIME\{"$day $month, $year - $hour:$min:$sec"\}% GMT">
* Set HTTP\_EQUIV\_ON\_EDIT =
* http-equiv meta tags for **_preview_** script:
* Set HTTP\_EQUIV\_ON\_PREVIEW =
* Users or groups allowed to change this %TOPIC% topic: (I.e. %MAINWEB%.TWikiAdminGroup)
* Set ALLOWTOPICCHANGE =
* Site-level preferences that are **not** allowed to be overridden by %WEBPREFSTOPIC% and user preferences:
* Set FINALPREFERENCES = PREVIEWBGIMAGE, WIKIWEBMASTER, MAILHOST
**_Plugin Preferences:_**
* 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. **TWiki.DefaultPlugin, TWiki.AnOtherPlugin**
)
* Set ACTIVEPLUGINS = [[TWiki/DefaultPlugin]]
* Set INACTIVEPLUGINS = [[TWiki/EmptyPlugin]]
* Preferences of [[DefaultPlugin]]:
* Allow depreciated %INCLUDE:"topic"%
syntax: (`0` or `1`)
* Set DEFAULTPLUGIN\_OLDINCLUDE = 1
**_Notes:_**
* A preference is defined as:
`6 spaces * Set NAME = value`
Example:
* Set WEBBGCOLOR = #FFFFC0
* Preferences are used as %TWIKIWEB%.TWikiVariables by enclosing the name in percent signs. Example:
* When you write variable %WEBBGCOLOR%
, it gets expanded to `%WEBBGCOLOR%` .
* 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.
* You can introduce new variables and use them in your topics and templates. There is no need to change the %WIKITOOLNAME% engine (Perl scripts).
**_Related Topics:_**
* %WEBPREFSTOPIC% has preferences of the %WIKITOOLNAME%.%WEB% web.
* %MAINWEB%.%WIKIUSERSTOPIC% has a list of user topics. User topics can have optional user preferences.
* %TWIKIWEB%.TWikiVariables has a list of common %VARIABLES%
.
* %TWIKIWEB%.TWikiAccessControl explains how to restrict access by users or groups.