TWiki Site-Level Preferences

This topic defines site-level settings that apply to all users and webs on this TWikiSite.

• Skin overriding the default TWiki templates: (can be overwritten by WebPreferences and user preferences)
  • Set SKIN = nat
  • Set SKINSTYLE = Gettysburg

• • Set STYLEBORDER = thin
  • Set STYLEBUTTONS = on
  • Set STYLESIDEBAR = right

TWiki Site-Level Preferences

This topic defines site-level settings that apply to all users and webs on this TWikiSite.

• Skin overriding the default TWiki templates: (can be overwritten by WebPreferences and user preferences)
  • Set SKIN = nat
  • Set SKINSTYLE = Gettysburg

• • Set STYLEBORDER = thin
  • Set STYLEBUTTONS = on

• • Set STYLESEARCHBOX = pos1

• Note: See TWikiSkinBrowser for currently installed skins

TWiki Site-Level Preferences

This topic defines site-level settings that apply to all users and webs on this TWikiSite.

• • Set FAVICON = /twiki/pub/TWiki/WebPreferences/favicon.ico

• Image, URL and alternate tooltip text of web's logo.

• List this web in the SiteMap:
  • If yes, set SITEMAPLIST to on, do not set NOSEARCHALL, and add the "what" and "use to..." description for the site map. Make sure to list only links that include the name of the web, e.g. TWiki.Topic links.

• • Set SITEMAPUSETO = ...to do something.

• Copyright notice:

Skin Settings

• Skin overriding the default TWiki templates: (can be overwritten by WebPreferences and user preferences)

• Note: See TWikiSkinBrowser for currently installed skins

TWiki Site-Level Preferences

This topic defines site-level settings that apply to all users and webs on this TWikiSite.

Note: This topic should be regarded as read-only, so that upgrades can safely overwrite it without risk to your customizations.

• Some skins have two editors available; the default editor, and a second editor which is usually a WYSIWYG editor (the second editor is used by hitting the WYSIWYG link in pattern or classic skins). If COMPOSER is not set, the second editor will work the same as the default editor. If the WysiwygPlugin is installed and it is set to 'kupu' (the default), then the Kupu WYSIWYG editor will be enabled. You can change the setting to use any editor that is enabled by setting the cover parameter on the edit URL.
  • Set COMPOSER = kupu

• Horizontal size of text edit box: (can be overwritten by user preferences)
  • Set EDITBOXWIDTH = 70

• Format of images when the link check box is checked: (can be overwritten by user preferences)
  • NOTE: Keyword $name gets expanded to filename; $comment to comment; $size to width="..." height="..." attribute of img tag; \t to tab and \n to linefeed (3 spaces for bullets).

• • Set ATTACHEDIMAGEFORMAT = \n * $comment:
    \n

TWiki Platform Settings

• • If you use PatternSkin:

• Users or groups allowed to create new webs: (ex: TWikiAdminGroup)
• This has been disabled for the TWiki-4.0.0 release due to a potential security hole - you must be in the TWikiAdminGroup? to create a web

E-mail Settings

• 'Mail this topic' mailto: link - can be included in topics, templates or skins
  • Set MAILTHISTOPIC = Send a link to this page

Plugins Settings

• You can enable/disable Plugins using the configure interface.

• Currently activated Plugins: SpreadSheetPlugin, ActionTrackerPlugin, AttachmentListPlugin, BreadCrumbsPlugin, CalendarPlugin, CommentPlugin, CompareRevisionsAddonPlugin, EditTablePlugin, FilterPlugin, FlexWebListPlugin, GluePlugin, IfDefinedPlugin, InterwikiPlugin, JQueryPlugin, NatSkinPlugin, PreferencesPlugin, RedDotPlugin, RenderListPlugin, SlideShowPlugin, SmiliesPlugin, TablePlugin, TwistyPlugin, VotePlugin, WysiwygPlugin

• NOTE: You can enable/disable Plugins by passing a comma-separated list of Plugin names in the debugenableplugins url parameter; for example, http://moglen.law.columbia.edu/twiki/bin/view/TWiki/TWikiPreferences?debugenableplugins=SmiliesPlugin will display this topic with all Plugins disabled except the SmiliesPlugin.
• Detailed diagnostics can be found in InstalledPlugins
• Legacy settings:

• NOTE: You can enable/disable Plugins by passing a comma-separated list of Plugin names in the debugenableplugins url parameter; for example, http://moglen.law.columbia.edu/twiki/bin/view/TWiki/TWikiPreferences?debugenableplugins=SmiliesPlugin will display this topic with all Plugins disabled except the SmiliesPlugin.
• Detailed diagnostics can be found in InstalledPlugins
• Legacy settings:

• • Set INSTALLEDPLUGINS = The INSTALLEDPLUGINS variable is no longer supported. You can set the Plugins execution order using the configure interface.

Rendering Shortcuts Settings

• Line break:

• Bullet sign:
  • Set BULLET = •

• Line break and bullet with different levels of indentation:
  • Set BB =
    •
  • Set BB2 =
      •
  • Set BB3 =
        •
  • Set BB4 =
          •

• Colored text: (see more StandardColors)

  You type:	%RED% red text %ENDCOLOR% and %GREEN% green text %ENDCOLOR%
  You get:	red text and green text

• • Set ENDCOLOR =

Miscellaneous Settings

• PreviewBackground image:
  • Set PREVIEWBGIMAGE = /twiki/pub/TWiki/PreviewBackground/preview2bg.gif

Access Control Settings

• Users or groups allowed to change or rename this TWikiPreferences topic:
  • Set ALLOWTOPICCHANGE = TWikiAdminGroup

Creating New Preference Variables

TWiki Site-Level Preferences

This topic defines site-level settings that apply to all users and webs on this TWikiSite.

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

• • Set ATTACHEDFILELINKFORMAT = \n * $name: $comment

• Format of images when the link check box is checked: (can be overwritten by user preferences)
  • NOTE: Keyword $name gets expanded to filename; $comment to comment; $size to width="..." height="..." attribute of img tag; \t to tab and \n to linefeed (3 spaces for bullets).

• Broadcast message for skins supporting a %BROADCASTMESSAGE% at the top of the page: (IMPORTANT: Set to empty message if not used; #Comment out unused messages)
  • Set BROADCASTMESSAGE =

• • If you use PatternSkin:
  • #Set BROADCASTMESSAGE =
    NOTE: Edit and Attach will be disabled today between 05:00 PM and 06:00 PM PDT (00:00 to 01:00 GMT) for a scheduled TWiki maintenance.

• • Set PREVIEWBGIMAGE = /twiki/pub/TWiki/PreviewBackground/preview2bg.gif

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

TWiki Site-Level Preferences

This topic defines site-level settings that apply to all users and webs on this TWikiSite.

• Simplified Copyright notice for the WebRss feed (don't use any special characters, html tags, entities, wiki markup or WikiWords)
  • Set WEBRSSCOPYRIGHT = Copyright 2008 by contributing authors

• • Set NOSEARCHALL =
• Prevent automatic linking of WikiWords and acronyms (if set to on); link WikiWords (if empty); can be overwritten by web preferences:
  • Set NOAUTOLINK =

Default Web Preferences

• • Set WEBTOPICLIST = Changes | Index | Search | Go

• • Set WEBBGCOLOR = #FFD8AA

• Copyright notice:

• • Set WEBRSSCOPYRIGHT = Copyright 2008 by contributing authors

• Exclude web from a web="all" search: (Set to on for hidden webs; is overwritten by web preferences)

• • Set NOAUTOLINK =
  • 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.

Default User Settings

• • Set LINKTOOLTIPINFO = off
  • #Set LINKTOOLTIPINFO = $username - $date - $rev: $summary

• 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)

• 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)
  • Set EDITBOXSTYLE = width: 99%

• 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 =

• Format of file link when the link check box is checked: (can be overwritten by user preferences)
  • 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)

TWiki Platform Settings

• TWiki site name:
  • Set WIKITOOLNAME = TWiki

• • Set WIKILOGOURL = http://TWiki.org/

• • Set WIKIWEBLIST = Main | TWiki | Sandbox
  • NOTE: To automatically list all non-hidden webs in alphabetical order, use the %WEBLIST{}% variable instead:
    

• Maximum size of FileAttachments in KB, 0 for no limit:
  • Set ATTACHFILESIZELIMIT = 10000

• Broadcast message for skins supporting a %BROADCASTMESSAGE% at the top of the page: (IMPORTANT: Set to empty message if not used; #Comment out unused messages)
  • Set BROADCASTMESSAGE =
  • #Set BROADCASTMESSAGE =

    NOTE:

• • If you use PatternSkin:
  • #Set BROADCASTMESSAGE =
    NOTE: Edit and Attach will be disabled today between 05:00 PM and 06:00 PM PDT (00:00 to 01:00 GMT) for a scheduled TWiki maintenance.

Search Settings

• Default type for search, one of: keyword (for search engine like syntax), regex (for RegularExpression search), or literal (for verbatim search)

• Stop words, e.g., common words and characters to exclude from a keyword search:
  • Set SEARCHSTOPWORDS = a, all, am, an, and, any, as, at, b, be, by, c, d, e, for, from, g, h, how, i, i'm, i.e., in, is, isn't, it, it's, its, j, k, l, m, n, o, of, on, or, p, q, r, s, t, that, that's, the, this, to, u, v, w, was, wasn't, what, what's, when, where, who, who's, will, with, x, y, z

• • Set WIKIWEBMASTERNAME = TWiki Administrator

• 'Mail this topic' mailto: link - can be included in topics, templates or skins

• 'Mail this topic' link text
  • Set MAILTHISTOPICTEXT = Send a link to this page

• URL for current topic

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:

• • Set HTTP_EQUIV_ON_EDIT =

• http-equiv meta tags for preview script:

• • Set HTTP_EQUIV_ON_PREVIEW =

Skin Settings

PatternSkin

Plugins Settings

• Line break:
  • Set BR =
    

• Background color of non existing topic: ( default cornsilk or #FFFFCE )
  • Set NEWTOPICBGCOLOR = #FFFFCE

• • Set PREVIEWBGIMAGE = /twiki/pub/TWiki/PreviewBackground/preview2bg.gif

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

• Preferences are used as TWikiVariables by enclosing the name in percent signs: %. Example:
  • When you write variable %WEBBGCOLOR%, it gets expanded to #FFD8AA .

Related Topics

• 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.

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), topic level (the topic being rendered), and on the user level (create preferences in your user account topic in the Main web, ex: TWikiGuest).

Skin Settings

• Skin overriding the default TWiki templates: (can be overwritten by WebPreferences and user preferences)

• Note: See TWikiSkinBrowser for currently installed skins

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), topic level (the topic being rendered), and on the user level (create preferences in your user account topic in the Main web, ex: TWikiGuest).

TWiki Platform Settings

• TWiki site name:

• Image, URL and alternate tooltip text of TWiki logo: (can be overwritten by web preferences)
  • Set WIKILOGOIMG =

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), topic level (the topic being rendered), and on the user level (create preferences in your user account topic in the Main web, ex: TWikiGuest).

• • Set WEBTOPICLIST = Changes | Index | Search | Go

• Web specific background color: (is overwritten by web preferences)

• Copyright notice:
  • Set WEBCOPYRIGHT = Copyright © 1999-2008 by the contributing authors. \nAll material on this collaboration platform is the property of the contributing authors.
    \nIdeas, requests, problems regarding TWiki? Send feedback

• • Set TOPICOVERRIDESUSER = off

• Site-level preferences that are not allowed to be overridden by WebPreferences and user preferences:

Creating New Preference Variables

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), topic level (the topic being rendered), and on the user level (create preferences in your user account topic in the Main web, ex: TWikiGuest).

• Copyright notice:
  • Set WEBCOPYRIGHT = Copyright © 1999-2008 by the contributing authors. \nAll material on this collaboration platform is the property of the contributing authors.
    \nIdeas, requests, problems regarding TWiki? Send feedback

• • Set WEBRSSCOPYRIGHT = Copyright 2008 by contributing authors

• Exclude web from a web="all" search: (Set to on for hidden webs; is overwritten by web preferences)

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), topic level (the topic being rendered), and on the user level (create preferences in your user account topic in the Main web, ex: TWikiGuest).

• • Set WEBBGCOLOR = #C0C0C0

• Copyright notice: