TWiki Site-Level Preferences

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

• • NOTE: Keyword $name gets expanded to filename; $comment to comment; \t to tab (3 spaces for bullets).

<-- verbatim tag required to prevent error in Apache log; does not suppress Set -->

• Format of images when the link check box is checked:

• TWikiDashboardAddOn variable, documented in VarDASHBOARD:
  • Set DASHBOARD = %INCLUDE{ "TWiki.TWikiDashboardAddOn" section="%section%" %IF{ "'%height{ default="" }%'!=''" then="height=\"%height%\"" }% %IF{ "'%width{ default="" }%'!=''" then="width=\"%width%\"" }% %IF{ "'%ENCODE{ "%image{ default="" }%" type="entity" }%'!=''" then="image=\"%image%\"" }% %IF{ "'%ENCODE{ "%title{ default="" }%" type="entity" }%'!=''" then="title=\"%title%\"" }% %IF{ "'%ENCODE{ "%button1{ default="" }%" type="entity" }%'!=''" then="button1=\"%button1%\"" }% %IF{ "'%ENCODE{ "%button2{ default="" }%" type="entity" }%'!=''" then="button2=\"%button2%\"" }% %IF{ "'%ENCODE{ "%button3{ default="" }%" type="entity" }%'!=''" then="button3=\"%button3%\"" }% %IF{ "'%ENCODE{ "%button4{ default="" }%" type="entity" }%'!=''" then="button4=\"%button4%\"" }% %IF{ "'%ENCODE{ "%button5{ default="" }%" type="entity" }%'!=''" then="button5=\"%button5%\"" }% %IF{ "'%ENCODE{ "%button6{ default="" }%" type="entity" }%'!=''" then="button6=\"%button6%\"" }% %IF{ "'%ENCODE{ "%button7{ default="" }%" type="entity" }%'!=''" then="button7=\"%button7%\"" }% %IF{ "'%ENCODE{ "%button8{ default="" }%" type="entity" }%'!=''" then="button8=\"%button8%\"" }% %IF{ "'%ENCODE{ "%style{ default="" }%" type="entity" }%'!=''" then="style=\"%style%\"" }% %IF{ "'%ENCODE{ "%titlestyle{ default="" }%" type="entity" }%'!=''" then="titlestyle=\"%titlestyle%\"" }% %IF{ "'%ENCODE{ "%contentstyle{ default="" }%" type="entity" }%'!=''" then="contentstyle=\"%contentstyle%\"" }% }%

• • Set ENDBG =

Miscellaneous Settings

TWiki Site-Level Preferences

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

• • NOTE: Keyword $name gets expanded to filename; $comment to comment; \t to tab (3 spaces for bullets).

<-- verbatim tag required to prevent error in Apache log; does not suppress Set -->

• Format of images when the link check box is checked:
  • NOTE: Keyword $name gets expanded to filename; $comment to comment; $width to width of image; $height to height of image; $size to width="..." height="..." attribute of img tag; \t to tab and \n to linefeed. Use 3 leading spaces for bullets.

• Users or groups allowed to create new top-level webs: (ex: WebCreatorsGroup). If set to nothing, only administrators will be able to do this.
  • Set ALLOWROOTCHANGE = TWikiAdminGroup

Search Settings

• Vertical caret symbol:
  • Set CARET = ^

• Left & right double angle quote:
  • Set LAQUO = «
  • Set RAQUO = »

• • Expands to:

    Grandma And Granpa » Mother And Father » Myself and me

  • Set PARENTBC = »

• Topic URL: URL of current topic
  • Set TOPICURL = https://sites.astro.caltech.edu/twiki_cstc/bin/view/TWiki/TWikiPreferences

TWiki Site-Level Preferences

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

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

• If you use non WikiWords for topic names (for example "Expenses" or "Mighty1") and if you use bracket notation to link to those topics, it is useful to turn of all warnings (like: "WARNING: This topic name is not recommended because it will not be linked automatically") and checkboxes ("Allow non WikiWord for the new topic name"). Can be overwritten by web preferences. Set to on to activate:
  • Set HIDE_NON_WIKI_WORD_WARNINGS =

• • • • If not set: nothing
      • Possible values: any string, for example On this page:
      • Can be overridden by title parameter of variable TOC

• • Do not show a TOC if the topic it contains is included in another topic:
    • Set TOC_HIDE_IF_INCLUDED =
      • If not set: included TOC is shown

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

• Horizontal size of text edit box:
  • Set EDITBOXWIDTH = 70

• List of TWiki webs - on the first line of the upper toolbar (to add a new web, see ManagingWebs and SiteMap):
  • Set WIKIWEBLIST = Main  |  TWiki  |  Sandbox

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

• • Set SEARCHVARDEFAULTTYPE = literal
• 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

E-mail Settings

• 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

• • Set BB =
    •
  • Set BB2 =
      •
  • Set BB3 =
        •
  • Set BB4 =
          •

• • Set BR =
    

• • Set BULLET = •

• • Set CARET = ^

• • Set TOPICURL = https://sites.astro.caltech.edu/twiki_cstc/bin/view/TWiki/TWikiPreferences

• • Set VBAR = |

• Hint: Above shortcuts are useful in TWiki tables where you cannot use newlines

• • Set S =
  • Set T =
  • Set U =

• • Set X =
  • Set Y =

• Format of a NewWikiWord link:
• Note that $text is the topic link text, $summary is the HTML-cleaned topic link text, $topic is the name of the new topic, and $web is the name of the web for the new topic. Values are taken from the link syntax [[$web.$topic][$text]]. For normal plain WikiWord links $text and $topic are the same. The value of $web is the current web unless the link is in the format $web.$topic.
  • default setting:

• • alternative setting:

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

Protected System Settings

• Set FINALPREFERENCES = WEB, TOPIC

Related Topics

TWiki Site-Level Preferences

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

Miscellaneous Settings

• Format of a NewWikiWord link:

• • default setting:

• • alternative setting:
    • #Set NEWLINKFORMAT = $text

TWiki Site-Level Preferences

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

• • Set SITEMAPLIST = on
  • Set SITEMAPWHAT = Describe what this web does

• Copyright notice:

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

• Warn if %INCLUDE{}% of topic fails: Fail silently if empty or off. Output warning message (defined in templates/oopsalerts.tmpl) if set to on. Otherwise output specific text (use $topic for topic). You can override this in web preferences, or by using a warn="..." parameter with %INCLUDE{}% :
  • Set INCLUDEWARNING = on

• Generated Table of Contents (TOC) settings
  • The first header level to appear in the TOC:
    • Set TOC_MIN_DEPTH =

• • • • If not set: included TOC is shown
      • Possible values: on or nothing

Default User Settings

NOTE: They are typically redefined in topics of individual TWikiUsers

• Preference for the editor, default is the WYSIWYG editor. The options are raw, wysiwyg:
  • Set EDITMETHOD = wysiwyg
  • #Set EDITMETHOD = raw

• Horizontal size of text edit box:
  • Set EDITBOXWIDTH = 70

• • NOTE: Keyword $name gets expanded to filename; $comment to comment; \t to tab (3 spaces for bullets).

<-- verbatim tag required to prevent error in Apache log; does not suppress Set -->

• Format of images when the link check box is checked:
  • NOTE: Keyword $name gets expanded to filename; $comment to comment; $width to width of image; $height to height of image; $size to width="..." height="..." attribute of img tag; \t to tab and \n to linefeed. Use 3 leading spaces for bullets.

TWiki Platform Settings

• TWiki site name:

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

• Users or groups allowed to create new top-level webs: (ex: WebCreatorsGroup). If set to nothing, only administrators will be able to do this.
  • Set ALLOWROOTCHANGE = TWikiAdminGroup

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

E-mail Settings

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

HTTP-EQUIV Settings

• NOTE: Changing cache behaviour with these settings should not be necessary and may cause cache-related problems (e.g. TWiki:Codev.BackFromPreviewLosesText or TWiki:Codev.RefreshEditPage). These settings do not affect proxy caches.

• http-equiv meta tags for preview script:
  • Set HTTP_EQUIV_ON_PREVIEW =

Skin Settings

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

• Note: See TWikiSkinBrowser for currently installed skins

PatternSkin

• • Set TWIKILAYOUTURL = /twiki_cstc/pub/TWiki/PatternSkin/layout.css
  • Set TWIKISTYLEURL = /twiki_cstc/pub/TWiki/PatternSkin/style.css
  • Set TWIKICOLORSURL = /twiki_cstc/pub/TWiki/PatternSkin/colors.css

• • Set WEBHEADERART = /twiki_cstc/pub/TWiki/PatternSkin/TWiki_header.gif
  • #Set WEBHEADERBGCOLOR = #faf8f0

Skin Icons

• Topic containing the icon graphics library. Icons can easily be rendered with %ICON{name}%.
  • Set ICONTOPIC = TWikiDocGraphics, SiteDocGraphics

Legacy Support

• Support for legacy "EDITTOPIC", used to be hard-coded, now replaced by TMPL:P conditional instantiation
  • Set EDITURL = /twiki_cstc/bin/edit/TWiki/TWikiPreferences?t=1734786950
  • Set EDITTOPIC = Edit

Plugins Settings

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

• • Set X =
  • Set Y =

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

• Colored background: (see more StandardColors)    

  You type:	%REDBG% red background %ENDBG%	%GREENBG% green background %ENDBG%
  You get:	red background	green background

• • Set ENDBG =

Miscellaneous Settings

• Format of a NewWikiWord link:

Security Settings

• Only TWiki administrators are allowed to change this topic:

• Disable WYSIWYG editor for this preferences topic only:
  • Local TINYMCEPLUGIN_DISABLE = on

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

• 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 TWiki administrator e-mail address.
• In order to protect your custom variables from being overwritten when upgrading the TWiki.TWikiPreferences topic, it is recommended that custom variables are defined in Main.TWikiPreferences.

Protected System Settings

The following settings are declared final to protect them as read only. These are system variables that should

• Set FINALPREFERENCES = WEB, TOPIC

Related Topics

• WebPreferences has preferences of the TWiki web.

TWiki Site-Level Preferences

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

• 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

TWiki Site-Level Preferences

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

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

• • Set EDITBOXWIDTH = 70

• • Set EDITBOXHEIGHT = 22

• • Set EDITBOXSTYLE = width:99%

• • Set FORCENEWREVISIONCHECKBOX =

• • Set DONTNOTIFYCHECKBOX =

• • Set ATTACHLINKBOX =

• • NOTE: Keyword $name gets expanded to filename; $comment to comment; \t to tab (3 spaces for bullets).

<-- verbatim tag required to prevent error in Apache log; does not suppress Set -->

      * Set ATTACHEDFILELINKFORMAT = \n   * [[%ATTACHURL%/$name][$name]]: $comment

• • NOTE: Keyword $name gets expanded to filename; $comment to comment; $width to width of image; $height to height of image; $size to width="..." height="..." attribute of img tag; \t to tab and \n to linefeed. Use 3 leading spaces for bullets.

      * Set ATTACHEDIMAGEFORMAT = \n   * $comment: <br />\n     <img src="%ATTACHURLPATH%/$name" alt="$name" $size />

Miscellaneous Settings

• Format of a NewWikiWord link:
• Note that $text is the topic link text, $topic is the name of the new topic, and $web is the name of the web for the new topic. Values for the 3 are taken from the link syntax [[$web.$topic][$text]]. For normal plain WikiWord links $text and $topic are the same. The value of $web is the current web unless the link is in the format $web.$topic.
  • default setting:

TWiki Site-Level Preferences

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

• • Set SITEMAPWHAT = Describe what this web does

• Copyright notice:

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

• Format of images when the link check box is checked: (can be overwritten by user preferences)

      * Set ATTACHEDIMAGEFORMAT = \n   * $comment: <br />\n     <img src="%ATTACHURLPATH%/$name" alt="$name" $size />

• • Set WIKILOGOURL = https://sites.astro.caltech.edu/twiki_cstc/bin/view/Main/WebHome
  • Set WIKILOGOALT = Home - this site is powered by TWiki(R)

• List of TWiki webs - on the first line of the upper toolbar (to add a new web, see ManagingWebs and SiteMap):
  • Set WIKIWEBLIST = Main  |  TWiki  |  Sandbox

TWiki Site-Level Preferences

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

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

• Copyright notice:
  • Set WEBCOPYRIGHT = Copyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
    Ideas, requests, problems regarding TWiki? Send feedback
    Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.TWikiPreferences

• Image, URL and alternate tooltip text of the logo for this installation: you should change these settings for your site, or they can be overwridden in WebPreferences for individual webs by defining these variables there.
  • Set WIKILOGOIMG =

• Home page of this site
  • Set WIKIHOMEURL = /twiki_cstc/bin/view

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

HTTP-EQUIV Settings

• NOTE: Changing cache behaviour with these settings should not be necessary and may cause cache-related problems (e.g. TWiki:Codev.BackFromPreviewLosesText or TWiki:Codev.RefreshEditPage). These settings do not affect proxy caches.

Skin Settings

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

• Note: See TWikiSkinBrowser for currently installed skins

• • Set WEBHEADERART = /twiki_cstc/pub/TWiki/PatternSkin/TWiki_header.gif
  • #Set WEBHEADERBGCOLOR = #faf8f0

• Topic containing the icon graphics library. Icons can easily be rendered with %ICON{name}%.

• Support for legacy "EDITTOPIC", used to be hard-coded, now replaced by TMPL:P conditional instantiation
  • Set EDITURL = /twiki_cstc/bin/edit/TWiki/TWikiPreferences?t=1734786950
  • Set EDITTOPIC = Edit

Rendering Shortcuts Settings

• Line break: Note that the setting has an intentional trailing space
  • Set BR =
    

• Bullet sign:
  • Set BULLET = •

• Vertical caret symbol:
  • Set CARET = ^

• Hint: Above shortcuts are useful in TWiki tables where you cannot use newlines

• Colored text: (see more StandardColors)

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

<-- Two sets of colors follow: Color test and color setting -->

Miscellaneous Settings

• User-friendly synonyms for system webs
  • Set DOCWEB = TWiki

• • Set ADMINLOGIN = internal admin login (use the username suggested and the password set in configure).

• • Set ALLOWTOPICCHANGE = TWikiAdminGroup
  • Set ALLOWTOPICRENAME = TWikiAdminGroup

Creating New Preference Variables

• User topics in Main 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

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

Miscellaneous Settings

• Format of a NewWikiWord link:
• Note that $text is the topic link text, $topic is the name of the new topic, and $web is the name of the web for the new topic. Values for the 3 are taken from the link syntax [[$web.$topic][$text]]. For normal plain WikiWord links $text and $topic are the same. The value of $web is the current web unless the link is in the format $web.$topic.
  • default setting:

• • alternative setting:
    • #Set NEWLINKFORMAT = $text

TWiki Site-Level Preferences

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

Search Settings

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

• Default for %SEARCH{}% variable, one of: keyword, regex, or literal
  • Set SEARCHVARDEFAULTTYPE = literal
• Stop words, e.g., common words and characters to exclude from a keyword search:

• Format of a NewWikiWord link:
• Note that $text is the topic link text, $topic is the name of the new topic, and $web is the name of the web for the new topic. Values for the 3 are taken from the link syntax [[$web.$topic][$text]]. For normal plain WikiWord links $text and $topic are the same. The value of $web is the current web unless the link is in the format $web.$topic.
  • default setting:

• • alternative setting:
    • #Set NEWLINKFORMAT = $text

TWiki Site-Level Preferences

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

• 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 TWiki administrator e-mail address.
• In order to protect your custom variables from being overwritten when upgrading the TWiki.TWikiPreferences topic, it is recommended that custom variables are defined in Main.TWikiPreferences.

Related Topics

TWiki Site-Level Preferences

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

• • Set WEBLOGOURL = https://sites.astro.caltech.edu/twiki_cstc/bin/view/Main/WebHome
  • Set WEBLOGOALT = Home - this site is powered by TWiki(R)

• • 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 SITEMAPLIST = on
  • Set SITEMAPWHAT = Describe what this web does.
  • Set SITEMAPUSETO = ...to do something.

• Copyright notice:

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

• Exclude web from a web="all" search: (Set to on for hidden webs; is overwritten by web preferences) Note it is much better to use TWikiAccessControls in individual webs to control who can and can't view the contents of a web. NOSEARCHALL is retained for compatibility, but you should avoid using it.
  • Set NOSEARCHALL =

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

• Warn if %INCLUDE{}% of topic fails: Fail silently if empty or off. Output warning message (defined in templates/oopsalerts.tmpl) if set to on. Otherwise output specific text (use $topic for topic). You can override this in web preferences, or by using a warn="..." parameter with %INCLUDE{}% :
  • Set INCLUDEWARNING = on

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

• • Set WIKITOOLNAME = TWiki

• Image, URL and alternate tooltip text of the logo for this installation: you should change these settings for your site, or they can be overwridden in WebPreferences for individual webs by defining these variables there.

• • Set WIKILOGOURL = http://TWiki.org/
  • Set WIKILOGOALT = Powered by TWiki

• Home page of this site
  • Set WIKIHOMEURL = /twiki_cstc/bin/view

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

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

Search Settings

PatternSkin

• Default TWiki styles

• Custom overriding styles (enabled pr. default but empty, to prevent browsers from fetching %USERLAYOUTURL%-style URLs)
  • Set USERLAYOUTURL =

• • Set USERCOLORSURL =

• PatternSkin header settings

Skin icons

• Topic containing the icon graphics library. Icons can easily be rendered with %ICON{name}%.

Legacy support

• Support for legacy "EDITTOPIC", used to be hard-coded, now replaced by TMPL:P conditional instantiation

Rendering Shortcuts Settings

• • Set BR =
    

• Bullet sign:

• Vertical bar / pipe symbol:
  • Set VBAR = |

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

Miscellaneous Settings

• • default setting:
    • Set NEWLINKFORMAT = $text?
  • alternative setting:
    • #Set NEWLINKFORMAT = $text

Access Control Settings

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

• • 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. For example, set WEBCOPYRIGHT before WIKIWEBMASTER since the copyright notice uses the TWiki administrator e-mail address.

Related Topics

• WebPreferences has preferences of the TWiki web.

• TWiki:Plugins.PreferencesPlugin makes editing preferences a snap.

Note: Can't edit?

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, BackupRestorePlugin, ColorPickerPlugin, CommentPlugin, DatePickerPlugin, EditTablePlugin, HeadlinesPlugin, InterwikiPlugin, JQueryPlugin, PreferencesPlugin, SetGetPlugin, SlideShowPlugin, SmiliesPlugin, TablePlugin, TagMePlugin, TinyMCEPlugin, TwistyPlugin, WatchlistPlugin, WysiwygPlugin

• NOTE: You can enable/disable Plugins by passing a comma-separated list of Plugin names in the debugenableplugins url parameter; for example, https://sites.astro.caltech.edu/twiki_cstc/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, https://sites.astro.caltech.edu/twiki_cstc/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_cstc/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_cstc/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 2024 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 2024 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_cstc/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-2024 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-2024 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 2024 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:

• Simplified Copyright notice for the WebRss feed (don't use any special characters or xml tags
  • Set WEBRSSCOPYRIGHT = Copyright 2024 by contributing authors

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

PatternSkin

• Using attachments for styles

DragonSkin

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

• Show tool-tip topic info on mouse-over of WikiWord links. Setting can be on, off, or customized. An empty setting or off setting disables the tool-tips (for better performance). The setting can contain $summary to show the topic summary, $date for the last change date, $rev for the revision, $username for the login name of the last editor, $wikiname for the WikiName, $wikiusername for Main.WikiName, $topic for the topic name, and $web for the web name

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

• Horizontal size of text edit box: (can be overwritten by user 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).

Skin Settings

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

• Default TWiki CSS styling topics where layout and style are are defined:
  • #Set TWIKILAYOUTTOPIC = TWikiLayout
  • #Set TWIKISTYLETOPIC = TWikiStyle

• • #Set USERLAYOUTURL = ../TWiki/%USERLAYOUTTOPIC%?skin=text&contenttype=text/css
  • #Set USERSTYLEURL = ../TWiki/%USERSTYLETOPIC%?skin=text&contenttype=text/css

Plugins Settings

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

• • Set WIKITOOLNAME = TWikibeta

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

• • Set WIKILOGOALT = TWiki home

• List of TWiki webs - on the first line of the upper toolbar (to add a new web, see ManagingWebs and SiteMap):

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

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

Search Settings

• http-equiv meta tags for view, rdiff, attach, search* scripts: