TWiki Site-Level Preferences

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.guest).

NOTE: You can lock individual settings at the site or web levels using User & Group Access Control - see section below.

TWiki Site-Level Preferences

General Preferences:

List of TWiki webs - on the first line of the upper toolbar (to add a new web, see ManagingWebs and TWikiWebsTable):
- Set WIKIWEBLIST = Main | TWiki | Know | Test?
- NOTE: To automatically list all non-hidden webs in alphabetical order, use this variable instead:
  Set WIKIWEBLIST = JHydra| Know | Main | Sandbox | TWiki |

List of selected topics in a web - the second line of the upper toolbar (usually overwritten in individual WebPreferences):
- Set WEBTOPICLIST = Home | Changes | Index | Search | Go

Copyright notice:
- Set WEBCOPYRIGHT = Copyright © 2001 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 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 Edit 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)
- Set RELEASEEDITLOCKCHECKBOX =

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)
- Set DONTNOTIFYCHECKBOX =

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)
- Set ATTACHLINKBOX =

Format of file link when the link check box is checked: (can be overwritten by user preferences)
- Set ATTACHEDFILELINKFORMAT = \t* $name: $comment
- NOTE: Keyword $name gets expanded to filename; $comment to comment; \t to tab (3 spaces for bullets).

Format of images when the link check box is checked: (can be overwritten by user preferences)
- Set ATTACHEDIMAGEFORMAT = \t* $comment:
- NOTE: Example image is broken because there is no attached image file.
- NOTE: Keyword $name gets expanded to filename; $comment to comment; $size to width="..." height="..." attribute of img tag; \t to tab (3 spaces for bullets).

Email Settings

TWiki webmaster email address:
- Set WIKIWEBMASTER = webmaster@your.company

Mail host for outgoing mail. This is used for WebChangesAlert if Perl module Net::SMTP is installed. If not, or if SMTPMAILHOST is empty, the external sendmail program is used instead (defined by $mailProgram in TWiki.cfg). Examples: mail.your.company or localhost
- Set SMTPMAILHOST = mail

Mail domain sending mail. SMTP requires that you identify the TWiki server sending mail. If not set, Net::SMTP will guess it for you. Ex: twiki.your.company
- Set SMTPSENDERHOST =

Plugins Settings

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.
- Set INSTALLEDPLUGINS = DefaultPlugin
- Set DISABLEDPLUGINS = EmptyPlugin
- Currently activated plugins: DefaultPlugin, InterwikiPlugin
- NOTE: You can enable/disable all plugins with the $disableAllPlugins flag in the lib/TWiki.cfg file.

HTTP-EQUIV Settings

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 =

Preferences Access Control

Users or groups allowed to change or rename this TWikiPreferences topic: (ex: TWikiAdminGroup)
- Set ALLOWTOPICCHANGE =
- Set ALLOWTOPICRENAME =

Site-level preferences that are not allowed to be overridden by WebPreferences and user preferences:
- Set FINALPREFERENCES = PREVIEWBGIMAGE, WIKIWEBMASTER, SMTPMAILHOST , SMTPSENDERHOST

Creating New Preference Variables

You can introduce new VARIABLES and use them in your topics and templates. There is no need to change the TWiki engine (Perl scripts).

A preference is defined in a TWikiShorthand bullet item: [3 spaces] * [space] Set NAME = value
Example (as a nested bullet item, indented 6 spaces):
- 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 #FFE0B0 .

The sequential order of the preference settings is significant. Define preferences that use other preferences FIRST. For example, set WEBCOPYRIGHT before WIKIWEBMASTER since the copyright notice uses the webmaster email address.

	TWiki > TWiki > TWikiPreferences (r1.23)	TWiki webs: Main \| TWiki \| Know \| Sandbox
	TWiki . { Welcome \| Register \| Changes \| Topics \| Index \| Search \| Go }

Revision r1.23 - 01 Jan 2002 - 00:51 GMT - PeterThoeny	Copyright © 1999-2004 by the contributing authors. All material on this collaboration platform is the property of the contributing authors. Ideas, requests, problems regarding TWiki? Send feedback.