TWiki Site-Level Preferences

The following settings are site-level preferences , e.g. affecting all users in all TWiki webs. These preferences can be overwritten by web preferences (topic WebPreferences in each TWiki web) and user preferences (your personal topic, i.e. TWikiGuest in the TWiki.Main web)

Preferences:

• List of TWiki webs: (the first line of a topic; to add a web see TWikiDocumentation and TWikiWebsTable)
  • Set WIKIWEBLIST = TWiki . { Main | TWiki | Know | Test }

• List of topics of a web: (the second line of a topic, is overwritten by web preferences)
  • Set WEBTOPICLIST = TWiki . { Home | Changes | Index | Search | 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 TWiki? Send 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

• PreviewBackground image:
  • Set PREVIEWBGIMAGE = /pub/TWiki/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 = webmaster@your.company

• 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 TWikiPreferences topic: (I.e. TWikiAdminGroup)
  • Set ALLOWTOPICCHANGE =

• Site-level preferences that are not allowed to be overridden by WebPreferences 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 = DefaultPlugin
  • Set INACTIVEPLUGINS = 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 TWikiVariables by enclosing the name in percent signs. Example:
  • When you write variable %WEBBGCOLOR% , it gets expanded to #FFD8AA .
• 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 TWiki engine (Perl scripts).

Related Topics:

• WebPreferences has preferences of the TWiki.TWiki web.
• TWikiUsers has a list of user topics. User topics can have optional user preferences.
• TWikiVariables has a list of common %VARIABLES% .
• TWikiAccessControl explains how to restrict access by users or groups.