Difference: TWikiPreferences (1 vs. 90)

Revision 902015-05-07 - TWikiContributor

Line: 1 to 1
 

TWiki Site-Level Preferences

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

Line: 125 to 125
 
    • HELP 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 -->
Changed:
<
<
    • Set ATTACHEDFILELINKFORMAT = \n * $name: $comment
>
>
    • Set ATTACHEDFILELINKFORMAT = \n * $name: $comment
 

  • Format of images when the link check box is checked:
Line: 270 to 270
  ParameterizedVariables for global use are defined here.
Added:
>
>
  • Children search:
    • Set CHILDREN = %METASEARCH{ type="parent" web="%web{ default="" }%" topic="%topic{ default="" }%" format="%format{ default="$topic" }%" separator="%separator{ default=", " }%" }%
 
  • 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%\"" }% }%
Line: 437 to 440
 
    • Set ENDBG =
Added:
>
>
      * Set TWOCOLUMNS = <div class="twikiTwoColumns">
      * Set THREECOLUMNS = <div class="twikiThreeColumns">
      * Set FOURCOLUMNS = <div class="twikiFourColumns">
      * Set ENDCOLUMNS = </div>
 

Miscellaneous Settings

Revision 892014-03-26 - TWikiContributor

Line: 1 to 1
 

TWiki Site-Level Preferences

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

Line: 125 to 125
 
    • HELP 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 -->
Changed:
<
<
    • Set ATTACHEDFILELINKFORMAT = \n * $name: $comment
>
>
    • Set ATTACHEDFILELINKFORMAT = \n * $name: $comment
 

  • Format of images when the link check box is checked:
    • HELP 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.
Changed:
<
<
    • Set ATTACHEDIMAGEFORMAT = \n * $comment:
      \n $name
>
>
    • Set ATTACHEDIMAGEFORMAT = \n * $comment:
      \n $name
 

Line: 164 to 164
 
Added:
>
>
 

Search Settings

Line: 296 to 298
 
Added:
>
>
 
Line: 309 to 314
 
Added:
>
>

 

Revision 882013-10-12 - TWikiContributor

Line: 1 to 1
 

TWiki Site-Level Preferences

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

Line: 49 to 49
 
    • 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.
Added:
>
>
  • Use topic title instead of topic name in forced links, such as in link [[BugItem1234]]. If enabled, the link label is set to the form field named "Title", the topic preferences setting named TITLE, or the topic name if neither exists. Forced links with label such as [[BugItem1234][bug 1234]] are not affected. The topic title can be shown even with disabled flag by using syntax [[+BugItem1234]]. NOTE: Page rendering may be slower if enabled and if there are many forced links in a topic.
    • Set SHOWTOPICTITLELINK =
 
  • 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 =

Line: 71 to 74
 
        • If not set: nothing
        • Possible values: any string, for example On this page:
        • Can be overridden by title parameter of variable TOC
Added:
>
>
    • The default TOC style:
      • Set TOC_STYLE =
        • If not set: nothing
        • Possible values: any CSS directive, for example float: right; border: dotted gray 1px;
        • Can be overridden by style 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
Line: 92 to 100
 
    • Set LINKTOOLTIPINFO = off
    • #Set LINKTOOLTIPINFO = $username - $date - $rev: $summary
Added:
>
>
  • In the user profile page, show the tag cloud instead of the watchlist changes in case the WatchlistPlugin is installed and enabled.
    • #Local TAGCLOUDPROFILE = on
 
  • Horizontal size of text edit box:
    • Set EDITBOXWIDTH = 70
Line: 139 to 150
 
Changed:
<
<
    • TIP NOTE: To automatically list all non-hidden webs in alphabetical order, use the %WEBLIST{}% variable instead:
      Main | TWiki
>
>
    • TIP NOTE: To automatically list all non-hidden webs in alphabetical order, use the %WEBLIST{}% variable instead:
      Main | TWiki
 
  • Maximum size of FileAttachments in KB, 0 for no limit:
    • Set ATTACHFILESIZELIMIT = 10000
Line: 162 to 173
 
    • 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
Added:
>
>
 

E-mail Settings

Line: 240 to 253
 
  • Legacy settings:
    • Set INSTALLEDPLUGINS = The INSTALLEDPLUGINS variable is no longer supported. You can set the Plugins execution order using the configure interface.
Added:
>
>
 
Added:
>
>

Parameterized Variables

ParameterizedVariables for global use are defined here.

  • 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%\"" }% }%

  • UserReports variable, documented in VarUSERREPORT:
    • Set USERREPORT = %INCLUDE{ "TWiki.UserReports" section="%action%" %IF{ "'%ENCODE{ "%search{ default="~~" }%" type="entity" }%'!='~~'" then="search=\"%search%\"" }% %IF{ "'%limit{ default="~~" }%'!='~~'" then="limit=\"%limit%\"" }% %IF{ "'%order{ default="~~" }%'!='~~'" then="order=\"%order%\"" }% %IF{ "'%sort{ default="~~" }%'!='~~'" then="sort=\"%sort%\"" }% %IF{ "'%reverse{ default="~~" }%'!='~~'" then="reverse=\"%reverse%\"" }% %IF{ "'%user{ default="~~" }%'!='~~'" then="user=\"%user%\"" }% %IF{ "'%users{ default="~~" }%'!='~~'" then="users=\"%users%\"" }% %IF{ "'%selected{ default="~~" }%'!='~~'" then="selected=\"%selected%\"" }% %IF{ "'%height{ default="~~" }%'!='~~'" then="height=\"%height%\"" }% %IF{ "'%width{ default="~~" }%'!='~~'" then="width=\"%width%\"" }% %IF{ "'%ENCODE{ "%title{ default="~~" }%" type="entity" }%'!='~~'" then="title=\"%title%\"" }% %IF{ "'%name{ default="~~" }%'!='~~'" then="name=\"%name%\"" }% %IF{ "'%columns{ default="~~" }%'!='~~'" then="columns=\"%columns%\"" }% %IF{ "'%ENCODE{ "%style{ default="~~" }%" type="entity" }%'!='~~'" then="style=\"%style%\"" }% %IF{ "'%ENCODE{ "%firstoption{ default="~~" }%" type="entity" }%'!='~~'" then="firstoption=\"%firstoption%\"" }% %IF{ "'%ENCODE{ "%firstvalue{ default="~~" }%" type="entity" }%'!='~~'" then="firstvalue=\"%firstvalue%\"" }% }%
    • Set USERSIG = %DEFAULT%
    • Set BUBBLESIG = %DEFAULT%
 

Rendering Shortcuts Settings

Changed:
<
<
  • Line break and bullet with different levels of indentation:
>
>
These TWikiRenderingShortcuts facilitate doc writing.

 
    • Set BB =
    • Set BB2 =
        •
    • Set BB3 =
          •
    • Set BB4 =
            •
Changed:
<
<
  • Line break: Note that the setting has an intentional trailing space
>
>
  • Line break: Note that the setting has an intentional trailing space
 
    • Set BR =
Changed:
<
<
  • Bullet sign:
>
>
 
    • Set BULLET = •
Changed:
<
<
  • Vertical caret symbol:
>
>
 
    • Set CARET = ^
Changed:
<
<
  • URL of current topic
>
>

  • Parent breadcrumbs for headings:
    • Add %PARENTBC% to a heading of a topic to show the breadcrumb of its parents. Parent topics are linked, topic names are shown spaced out in a smaller font, and are separated by » quotes. In addition, a parentlist SetGetPlugin variable is set to the parent list, and a parent variable is set to the immediate parent. This can be retrieved later in the topic using %GET{parentlist}% and %GET{parent}%, respectively.
    • Example raw text:
      ---+ %PARENTBC% Myself and me
    • Expands to:

      Grandma And Granpa » Mother And Father » Myself and me

    • Set PARENTBC = »

 
Changed:
<
<
  • Vertical bar / pipe symbol:
>
>
 
    • Set VBAR = |

  • Hint: Above shortcuts are useful in TWiki tables where you cannot use newlines
Line: 284 to 328
 
    • Set S = PICK
    • Set T = TIP
    • Set U = UPDATED
Added:
>
>
    • Set WIP = Work in Progess!
 
    • Set X = ALERT!
    • Set Y = DONE
Line: 387 to 432
 
  • 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:
Changed:
<
<
      • Set NEWLINKFORMAT = $text
>
>
      • Set NEWLINKFORMAT = $text
 
    • alternative setting:
Changed:
<
<
      • #Set NEWLINKFORMAT = $text
>
>
      • #Set NEWLINKFORMAT = $text

  • User signature format. The SIGNATUREFORMAT is used when creating new topics, BUBBLESIGNATUREFORMAT is used when adding comments with CommentPlugin:
    • default setting:
      • Set BUBBLESIGNATUREFORMAT = -- TWiki Guest - 2024-10-15
      • Set SIGNATUREFORMAT = -- TWiki Guest - 2024-10-15
      • Note: The USERSIG is defined in section "user_sig" of UserReports. The desired expanded signature format in a topic is %USERSIG{%WIKINAME% - %DATE%}%, this with unexpanded USERSIG, but expanded WIKINAME and DATE. A hack using CALCULATE is used to keep USERSIG unexpanded: %CALCULATE{%U}%SERSIG{...}%
    • alternative legacy setting:
      • #Set SIGNATUREFORMAT = -- TWikiGuest - 2024-10-15
 
  • PreviewBackground image:
    • Set PREVIEWBGIMAGE = /twiki_cstc/pub/TWiki/PreviewBackground/preview2bg.gif
Line: 426 to 479
 

Protected System Settings

Changed:
<
<
The following settings are declared final to protect them as read only. These are system variables that should never be attempted set or altered in any preference topic or topic settings.
>
>
The following settings are declared final to protect them as read only. These are system variables that should never be attempted set or altered in any preference topic or topic settings.
 
  • Set FINALPREFERENCES = WEB, TOPIC
Added:
>
>
This topic should not be edited.

  • Local READONLYSKINMODE = 1
 

Related Topics

Revision 872013-01-06 - TWikiContributor

Line: 1 to 1
 

TWiki Site-Level Preferences

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

Line: 385 to 385
 

Miscellaneous Settings

Changed:
<
<
  • 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.
>
>
  • 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:
Changed:
<
<
      • Set NEWLINKFORMAT = $text
>
>
      • Set NEWLINKFORMAT = $text
 
    • alternative setting:
      • #Set NEWLINKFORMAT = $text

Revision 862012-09-16 - TWikiContributor

Line: 1 to 1
 

TWiki Site-Level Preferences

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

Line: 35 to 35
 
    • Set SITEMAPLIST = on
    • Set SITEMAPWHAT = Describe what this web does
Added:
>
>
 
  • Copyright notice:
Changed:
<
<
    • Set WEBCOPYRIGHT = This site is powered by the TWiki collaboration platformCopyright © 2008-2024 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
      Ideas, requests, problems regarding TWiki? Send feedback
>
>
    • Set WEBCOPYRIGHT = Copyright © 2008-2024 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
      Ideas, requests, problems regarding TWiki? Send feedback
 
  • 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
Line: 52 to 55
 
  • 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
Added:
>
>
 
  • Generated Table of Contents (TOC) settings
    • The first header level to appear in the TOC:
      • Set TOC_MIN_DEPTH =
Line: 72 to 76
 
        • If not set: included TOC is shown
        • Possible values: on or nothing
Added:
>
>
 

Default User Settings

ALERT! NOTE: They are typically redefined in topics of individual TWikiUsers

Deleted:
<
<
  • 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 = off
    • #Set LINKTOOLTIPINFO = $username - $date - $rev: $summary
 
  • Preference for the editor, default is the WYSIWYG editor. The options are raw, wysiwyg:
    • Set EDITMETHOD = wysiwyg
    • #Set EDITMETHOD = raw
Added:
>
>
  • Fixed pulldown menu-bar, on or off. If on, the menu-bar is always visible at the top, regardless of the window scroll position. If off, the menu-bar hides when scrolled, and can be shown by hovering over the gray TWiki icon.
    • Set FIXEDTOPMENU = off

  • 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 = off
    • #Set LINKTOOLTIPINFO = $username - $date - $rev: $summary
 
  • Horizontal size of text edit box:
    • Set EDITBOXWIDTH = 70
Line: 106 to 114
 
    • HELP 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 -->
Changed:
<
<
    • Set ATTACHEDFILELINKFORMAT = \n * $name: $comment
>
>
    • Set ATTACHEDFILELINKFORMAT = \n * $name: $comment
 

  • Format of images when the link check box is checked:
    • HELP 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.
Changed:
<
<
    • Set ATTACHEDIMAGEFORMAT = \n * $comment:
      \n $name
>
>
    • Set ATTACHEDIMAGEFORMAT = \n * $comment:
      \n $name
 
Added:
>
>
 

TWiki Platform Settings

  • TWiki site name:
Line: 136 to 145
 
  • Maximum size of FileAttachments in KB, 0 for no limit:
    • Set ATTACHFILESIZELIMIT = 10000
Added:
>
>
 
  • 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.
Line: 143 to 153
 
Added:
>
>
 

Search Settings

  • Default type for search, one of: keyword (for search engine like syntax), regex (for RegularExpression search), or literal (for verbatim search)
Line: 152 to 163
 
  • 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
Added:
>
>
 

E-mail Settings

  • 'Mail this topic' mailto: link - can be included in topics, templates or skins
Line: 160 to 172
 
  • 'Mail this topic' link text
    • Set MAILTHISTOPICTEXT = Send a link to this page
Added:
>
>
 

HTTP-EQUIV Settings

Line: 175 to 188
 
  • http-equiv meta tags for preview script:
    • Set HTTP_EQUIV_ON_PREVIEW =
Added:
>
>
 

Skin Settings

  • Skin overriding the default TWiki templates: (can be overwritten by WebPreferences and user preferences)
Line: 182 to 196
 
Added:
>
>
 

PatternSkin

Changed:
<
<
  • Default TWiki styles
>
>
 
    • 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
Line: 198 to 213
 
    • Set WEBHEADERART = /twiki_cstc/pub/TWiki/PatternSkin/TWiki_header.gif
    • #Set WEBHEADERBGCOLOR = #faf8f0

Added:
>
>
 

Skin Icons

Added:
>
>
 

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=1728966561
    • Set EDITTOPIC = Edit
Added:
>
>
 

Plugins Settings

  • You can enable/disable Plugins using the configure interface.
Line: 269 to 287
 
    • Set X = ALERT!
    • Set Y = DONE
Added:
>
>
 
  • Colored text: (see more StandardColors)
    You type: %RED% red text %ENDCOLOR% and %GREEN% green text %ENDCOLOR%
    You get: red text and green text
Line: 315 to 334
 
    • Set ENDCOLOR =
Added:
>
>
 
  • Colored background: (see more StandardColors)    
    You type: %REDBG% red background %ENDBG% %GREENBG% green background %ENDBG%
    You get:
    red background
    green background
Line: 361 to 381
 
    • Set ENDBG =
Added:
>
>
 

Miscellaneous Settings

Line: 381 to 402
  then="TWiki is configured using ApacheLogin, please login as a normal user first. Then the Admin Login will replace this text" else="internal admin login (use the username suggested and the password set in configure)."}%
Added:
>
>
 

Security Settings

  • Only TWiki administrators are allowed to change this topic:
Line: 389 to 411
 
  • Disable WYSIWYG editor for this preferences topic only:
    • Local TINYMCEPLUGIN_DISABLE = on
Added:
>
>
 

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

Line: 400 to 423
 
  • ALERT! 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.
  • ALERT! 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.
Added:
>
>
 

Protected System Settings

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

Line: 407 to 431
 
  • Set FINALPREFERENCES = WEB, TOPIC
Added:
>
>
 

Related Topics

Revision 852011-06-12 - TWikiContributor

Line: 1 to 1
 

TWiki Site-Level Preferences

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

Line: 222 to 222
 
  • Legacy settings:
    • Set INSTALLEDPLUGINS = The INSTALLEDPLUGINS variable is no longer supported. You can set the Plugins execution order using the configure interface.
Added:
>
>
<-- Legacy settings for CommentPlugin: 
  • Name of file in the 'templates' directory that contains the comment templates:
    • Set COMMENTPLUGIN_TEMPLATES = comments
  • Default template type:
    • Set COMMENTPLUGIN_DEFAULT_TYPE = above
-->
 

Rendering Shortcuts Settings

Revision 842010-11-05 - TWikiContributor

Line: 1 to 1
 

TWiki Site-Level Preferences

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

Line: 80 to 80
 
    • Set LINKTOOLTIPINFO = off
    • #Set LINKTOOLTIPINFO = $username - $date - $rev: $summary
Changed:
<
<
  • Horizontal size of text edit box: (can be overwritten by user preferences)
>
>
  • 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
Changed:
<
<
  • Vertical size of text edit box: (can be overwritten by user preferences)
>
>
  • Vertical size of text edit box:
 
    • Set EDITBOXHEIGHT = 22
Changed:
<
<
  • 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)
>
>
  • 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.
 
    • Set EDITBOXSTYLE = width:99%
Changed:
<
<
  • Default state of the Force New Revision (ForceNewRevision) check box in preview. Check box is initially checked if Set FORCENEWREVISIONCHECKBOX = checked="checked", or unchecked if empty: (can be overwritten by user preferences)
>
>
  • Default state of the Force New Revision (ForceNewRevision) check box in preview. Check box is initially checked if Set FORCENEWREVISIONCHECKBOX = checked="checked", or unchecked if empty:
 
    • Set FORCENEWREVISIONCHECKBOX =
Changed:
<
<
  • 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)
>
>
  • 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:
 
    • Set DONTNOTIFYCHECKBOX =
Changed:
<
<
  • 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)
>
>
  • 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:
 
    • Set ATTACHLINKBOX =
Changed:
<
<
  • Format of file link when the link check box is checked: (can be overwritten by user preferences)
>
>
  • Format of file link when the link check box is checked:
 
    • HELP 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
Changed:
<
<
  • Format of images when the link check box is checked: (can be overwritten by user preferences)
>
>
  • Format of images when the link check box is checked:
 
    • HELP 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 />
Line: 352 to 356
 

Miscellaneous Settings

Deleted:
<
<
  • Preference for the editor, default is raw editor, The options could be rawedit, wysiwyg.
    • Set EDITMETHOD = wysiwyg
    • #Set EDITMETHOD = rawedit
 
  • 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:

Revision 832010-06-29 - TWikiContributor

Line: 1 to 1
 

TWiki Site-Level Preferences

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

Line: 36 to 36
 
    • Set SITEMAPWHAT = Describe what this web does

  • Copyright notice:
Changed:
<
<
    • Set WEBCOPYRIGHT = This site is powered by the TWiki collaboration platformCopyright © 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
>
>
    • Set WEBCOPYRIGHT = This site is powered by the TWiki collaboration platformCopyright © 2008-2024 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
      Ideas, requests, problems regarding TWiki? Send feedback
 
  • 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
Line: 106 to 106
 

  • Format of images when the link check box is checked: (can be overwritten by user preferences)
Changed:
<
<
    • HELP 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).
>
>
    • HELP 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 />
Line: 121 to 121
 
Changed:
<
<
  • Home page of this site
    • Set WIKIHOMEURL = /twiki_cstc/bin/view
>
>
  • Home page of this site. This is DEPRECATED, please use %WIKILOGOURL% instead.
    • Set WIKIHOMEURL = /twiki_cstc/bin/view/Main/WebHome
 

Revision 822010-05-26 - TWikiContributor

Line: 1 to 1
 

TWiki Site-Level Preferences

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

Changed:
<
<
ALERT! Note: This topic should be regarded as read-only, so that upgrades can safely overwrite it without risk to your customizations.
>
>
ALERT! NOTE: Don't edit this topic, changes will be lost on the next TWiki upgrade. Define new site-level settings, or overload below settings in Main.TWikiPreferences
  Preference settings local to your site should be set in Main.TWikiPreferences (this topic is pointed to by {LocalSitePreferences}, which is set by the admin in the configure interface). Settings in Main.TWikiPreferences will override settings in this topic, and should be used for defining custom settings and variables.
Line: 33 to 33
 
  • 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
Changed:
<
<
    • Set SITEMAPWHAT = Describe what this web does.
    • Set SITEMAPUSETO = ...to do something.
>
>
    • Set SITEMAPWHAT = Describe what this web does
 
  • Copyright notice:
    • Set WEBCOPYRIGHT = This site is powered by the TWiki collaboration platformCopyright © 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
Line: 119 to 118
 
  • 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 = T-logo-140x40-t.gif
Changed:
<
<
>
>
 
  • Home page of this site
    • Set WIKIHOMEURL = /twiki_cstc/bin/view
Line: 157 to 156
 
  • 'Mail this topic' link text
    • Set MAILTHISTOPICTEXT = Send a link to this page
Deleted:
<
<
 

HTTP-EQUIV Settings

Line: 180 to 174
 

Skin Settings

  • Skin overriding the default TWiki templates: (can be overwritten by WebPreferences and user preferences)
Changed:
<
<
    • Set SKIN = pattern
>
>
    • Set SKIN = tagme, topmenu, pattern
 
Line: 200 to 194
 
    • Set WEBHEADERART = /twiki_cstc/pub/TWiki/PatternSkin/TWiki_header.gif
    • #Set WEBHEADERBGCOLOR = #faf8f0

Changed:
<
<

Skin icons

>
>

Skin Icons

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

Legacy Support

 
Deleted:
<
<

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=1728966562
    • Set EDITTOPIC = Edit
Line: 226 to 221
 

Rendering Shortcuts Settings

Added:
>
>
  • Line break and bullet with different levels of indentation:
    • Set BB =
    • Set BB2 =
        •
    • Set BB3 =
          •
    • Set BB4 =
            •
 
  • Line break: Note that the setting has an intentional trailing space
    • Set BR =

  • Bullet sign:
    • Set BULLET = •
Deleted:
<
<
  • Vertical bar / pipe symbol:
    • Set VBAR = |
 
  • Vertical caret symbol:
    • Set CARET = ^
Changed:
<
<
  • Line break and bullet with different levels of indentation:
    • Set BB =
    • Set BB2 =
        •
    • Set BB3 =
          •
    • Set BB4 =
            •
>
>

  • Vertical bar / pipe symbol:
    • Set VBAR = |
 
  • Hint: Above shortcuts are useful in TWiki tables where you cannot use newlines
Line: 263 to 261
 
  • Colored text: (see more StandardColors)
    You type: %RED% red text %ENDCOLOR% and %GREEN% green text %ENDCOLOR%
    You get: red text and green text
Changed:
<
<
    • Note: %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%.
>
>
    • Note: %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, such as %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%.
 
<-- Two sets of colors follow: Color test and color setting -->
Changed:
<
<
    • Set YELLOW = looks like this
    • Set ORANGE = looks like this
    • Set RED = looks like this
    • Set PINK = looks like this
    • Set PURPLE = looks like this
    • Set TEAL = looks like this
    • Set NAVY = looks like this
    • Set BLUE = looks like this
    • Set AQUA = looks like this
    • Set LIME = looks like this
    • Set GREEN = looks like this
    • Set OLIVE = looks like this
    • Set MAROON = looks like this
    • Set BROWN = looks like this
    • Set BLACK = looks like this
    • Set GRAY = looks like this
    • Set SILVER = looks like this
    • Set WHITE = looks like this (with gray background)
    • The following color settings are enclosed in verbatim tags to avoid incorrect nesting of XHTML tags:
>
>
    • %YELLOW% looks like this
    • %ORANGE% looks like this
    • %RED% looks like this
    • %PINK% looks like this
    • %PURPLE% looks like this
    • %TEAL% looks like this
    • %NAVY% looks like this
    • %BLUE% looks like this
    • %AQUA% looks like this
    • %LIME% looks like this
    • %GREEN% looks like this
    • %OLIVE% looks like this
    • %MAROON% looks like this
    • %BROWN% looks like this
    • %BLACK% looks like this
    • %GRAY% looks like this
    • %SILVER% looks like this
    • %WHITE% looks like this (with gray background)
    • The following settings define the colors: (they are enclosed in verbatim tags to avoid incorrect nesting of XHTML tags)
 
Changed:
<
<
    • Set YELLOW =
    • Set ORANGE =
    • Set RED =
    • Set PINK =
    • Set PURPLE =
    • Set TEAL =
    • Set NAVY =
    • Set BLUE =
    • Set AQUA =
    • Set LIME =
    • Set GREEN =
    • Set OLIVE =
    • Set MAROON =
    • Set BROWN =
    • Set BLACK =
    • Set GRAY =
    • Set SILVER =
    • Set WHITE =
    • Set ENDCOLOR =
>
>
    • Set YELLOW =
    • Set ORANGE =
    • Set RED =
    • Set PINK =
    • Set PURPLE =
    • Set TEAL =
    • Set NAVY =
    • Set BLUE =
    • Set AQUA =
    • Set LIME =
    • Set GREEN =
    • Set OLIVE =
    • Set MAROON =
    • Set BROWN =
    • Set BLACK =
    • Set GRAY =
    • Set SILVER =
    • Set WHITE =
    • Set ENDCOLOR =

  • Colored background: (see more StandardColors)    
    You type: %REDBG% red background %ENDBG% %GREENBG% green background %ENDBG%
    You get:
    red background
    green background
    • Note: These background colors are block level elements, e.g. take up a whole row of text by default. Useful to set background colors in cells of TWiki tables.
      <-- Two sets of colors follow: Color test and color setting -->
    • %YELLOWBG% looks like this
    • %ORANGEBG% looks like this
    • %REDBG% looks like this
    • %PINKBG% looks like this
    • %PURPLEBG% looks like this
    • %TEALBG% looks like this
    • %NAVYBG% looks like this
    • %BLUEBG% looks like this
    • %AQUABG% looks like this
    • %LIMEBG% looks like this
    • %GREENBG% looks like this
    • %OLIVEBG% looks like this
    • %MAROONBG% looks like this
    • %BROWNBG% looks like this
    • %BLACKBG% looks like this
    • %GRAYBG% looks like this
    • %SILVERBG% looks like this
    • %WHITEBG% looks like this
    • The following settings define the background colors: (they are enclosed in verbatim tags to avoid incorrect nesting of XHTML tags)
      * Set YELLOWBG = <div style="background-color: #ffff80; padding:0 3px 0 3px">
      * Set ORANGEBG = <div style="background-color: #ffbb80; padding:0 3px 0 3px">
      * Set REDBG = <div style="background-color: #ff8080; padding:0 3px 0 3px">
      * Set PINKBG = <div style="background-color: #ff80ff; padding:0 3px 0 3px">
      * Set PURPLEBG = <div style="background-color: #dd99dd; padding:0 3px 0 3px">
      * Set TEALBG = <div style="background-color: #80c0c0; padding:0 3px 0 3px">
      * Set NAVYBG = <div style="background-color: #8080c0; padding:0 3px 0 3px">
      * Set BLUEBG = <div style="background-color: #8080ff; padding:0 3px 0 3px">
      * Set AQUABG = <div style="background-color: #80ffff; padding:0 3px 0 3px">
      * Set LIMEBG = <div style="background-color: #80ff80; padding:0 3px 0 3px">
      * Set GREENBG = <div style="background-color: #99cc99; padding:0 3px 0 3px">
      * Set OLIVEBG = <div style="background-color: #c0c080; padding:0 3px 0 3px">
      * Set MAROONBG = <div style="background-color: #c08080; padding:0 3px 0 3px">
      * Set BROWNBG = <div style="background-color: #bb9988; padding:0 3px 0 3px">
      * Set BLACKBG = <div style="background-color: #000000; padding:0 3px 0 3px">
      * Set GRAYBG = <div style="background-color: #a0a0a0; padding:0 3px 0 3px">
      * Set SILVERBG = <div style="background-color: #c0c0c0; padding:0 3px 0 3px">
      * Set WHITEBG = <div style="background-color: #ffffff; padding:0 3px 0 3px">
      * Set ENDBG = </div>
 

Miscellaneous Settings

Line: 324 to 369
 
  • User-friendly synonyms for system webs
    • Set DOCWEB = TWiki

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

Access Control Settings

>
>

Security Settings

 
Changed:
<
<
  • No-one (except admins) should change this topic
>
>
  • Only TWiki administrators are allowed to change this topic:
 
Added:
>
>
  • Disable WYSIWYG editor for this preferences topic only:
    • Local TINYMCEPLUGIN_DISABLE = on
 

Creating New Preference Variables

Line: 359 to 406
 
  • 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.
Changed:
<
<
>
>
  Note: Can't edit? View raw topic
Added:
>
>
ALERT! NOTE: Don't edit this topic, changes will be lost on the next TWiki upgrade. Define new site-level settings, or overload above settings in Main.TWikiPreferences

Revision 812009-03-22 - TWikiContributor

Line: 1 to 1
 

TWiki Site-Level Preferences

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

Line: 307 to 307
 

Miscellaneous Settings

Added:
>
>
  • Preference for the editor, default is raw editor, The options could be rawedit, wysiwyg.
    • Set EDITMETHOD = wysiwyg
    • #Set EDITMETHOD = rawedit
 
  • 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:
Changed:
<
<
      • Set NEWLINKFORMAT = $text
>
>
      • Set NEWLINKFORMAT = $text
 
    • alternative setting:
      • #Set NEWLINKFORMAT = $text

Revision 802009-03-22 - TWikiContributor

Line: 1 to 1
 

TWiki Site-Level Preferences

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

Line: 143 to 143
 

Search Settings

  • Default type for search, one of: keyword (for search engine like syntax), regex (for RegularExpression search), or literal (for verbatim search)
Changed:
<
<
    • Set SEARCHDEFAULTTTYPE = keyword
>
>
    • Set SEARCHDEFAULTTYPE = keyword
 
  • 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:
Line: 311 to 311
 
  • 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:
Changed:
<
<
      • Set NEWLINKFORMAT = $text?
>
>
      • Set NEWLINKFORMAT = $text
 
    • alternative setting:
      • #Set NEWLINKFORMAT = $text

Revision 792007-04-14 - TWikiContributor

Line: 1 to 1
 

TWiki Site-Level Preferences

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

Line: 343 to 343
 
  • ALERT! 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.
  • ALERT! 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.
Added:
>
>

Protected System Settings

The following settings are declared final to protect them as read only. These are system variables that should never be attempted set or altered in any preference topic or topic settings.

  • Set FINALPREFERENCES = WEB, TOPIC
 

Related Topics

Revision 782007-04-14 - TWikiContributor

Line: 1 to 1
 

TWiki Site-Level Preferences

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

Line: 9 to 9
  Read more on how to set Preferences Variables.
Deleted:
<
<
(Click for form-based editing of existing preferences.)
 

Line: 32 to 30
 
Changed:
<
<
>
>
 
    • 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:
Changed:
<
<
    • Set WEBCOPYRIGHT = This site is powered by the TWiki collaboration platformCopyright © 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
>
>
    • Set WEBCOPYRIGHT = This site is powered by the TWiki collaboration platformCopyright © 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
 
  • 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 =
Changed:
<
<
  • Prevent automatic linking of WikiWords and acronyms (if set to on); link WikiWords (if empty); can be overwritten by web preferences:
>
>
  • Prevent automatic linking of WikiWords and acronyms (if set to on); link WikiWords (if empty); can be 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.
Added:
>
>
  • 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 =
 
  • 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
Added:
>
>
  • Generated Table of Contents (TOC) settings
    • The first header level to appear in the TOC:
      • Set TOC_MIN_DEPTH =
        • If not set: 1
        • Possible values: 1 to 6
    • The last header level to appear in the TOC:
      • Set TOC_MAX_DEPTH =
        • If not set: 6
        • Possible values: 1 to 6
        • Can be overridden by depth parameter of variable TOC
    • The default TOC title:
      • Set TOC_TITLE =
        • 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
        • Possible values: on or nothing

 

Default User Settings

Changed:
<
<
ALERT! NOTE: They are typically redefined in topics of individual TWikiUsers
>
>
ALERT! NOTE: They are typically redefined in topics of individual TWikiUsers
 
Changed:
<
<
  • 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
>
>
  • 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 = off
    • #Set LINKTOOLTIPINFO = $username - $date - $rev: $summary
Deleted:
<
<
  • 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
    • Enable content checks before editing
    • Set WYSWIYGPLUGIN_WYSIWYGSKIN = kupu
    • Disable WYSIWYG on pages that contain complex TML. On pages that have complex TML, WYSIWYG will fall back to the default text editor.
    • Set WYSIWYG_EXCLUDE = calls
 
  • Horizontal size of text edit box: (can be overwritten by user preferences)
    • Set EDITBOXWIDTH = 70
Line: 105 to 118
 
    • 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.
Changed:
<
<
    • Set WIKILOGOIMG = T-logo-140x40-t.gif
>
>
    • Set WIKILOGOIMG = T-logo-140x40-t.gif
 

  • Home page of this site
    • Set WIKIHOMEURL = /twiki_cstc/bin/view
Changed:
<
<
>
>
 
    • TIP NOTE: To automatically list all non-hidden webs in alphabetical order, use the %WEBLIST{}% variable instead:
      Main | TWiki
Changed:
<
<
>
>
 
    • 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 =
Changed:
<
<
    • #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.
    • 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 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

Line: 179 to 187
 

PatternSkin

  • Default TWiki styles
Changed:
<
<
    • 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 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
 
  • Custom overriding styles (enabled pr. default but empty, to prevent browsers from fetching %USERLAYOUTURL%-style URLs)
    • Set USERLAYOUTURL =
Line: 189 to 197
 
    • Set USERCOLORSURL =

  • PatternSkin header settings
Changed:
<
<
    • Set WEBHEADERART = /twiki_cstc/pub/TWiki/PatternSkin/TWiki_header.gif
    • Set WEBHEADERBGCOLOR = #ffffff
>
>
    • 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}%.
Changed:
<
<
>
>
 

Legacy support

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

Rendering Shortcuts Settings

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

  • Bullet sign:
Line: 227 to 235
 
  • Vertical bar / pipe symbol:
    • Set VBAR = |
Added:
>
>
  • Vertical caret symbol:
    • Set CARET = ^
 
  • Line break and bullet with different levels of indentation:
    • Set BB =
    • Set BB2 =
        •
Line: 297 to 308
 

Miscellaneous Settings

Changed:
<
<
>
>
  • 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:
      • Set NEWLINKFORMAT = $text?
    • alternative setting:
      • #Set NEWLINKFORMAT = $text
Changed:
<
<
  • PreviewBackground image:
    • Set PREVIEWBGIMAGE = /twiki_cstc/pub/TWiki/PreviewBackground/preview2bg.gif
>
>
  • PreviewBackground image:
    • Set PREVIEWBGIMAGE = /twiki_cstc/pub/TWiki/PreviewBackground/preview2bg.gif

  • User-friendly synonyms for system webs
    • Set DOCWEB = TWiki
 
Changed:
<
<
  • User-friendly synonyms for MAINWEB and TWIKIWEB
    • Set USERSWEB = Main
    • Set SYSTEMWEB = TWiki
    • Set DOCWEB = TWiki
>
>
 

Access Control Settings

Changed:
<
<
  • Users or groups allowed to change or rename this TWikiPreferences topic:
  • By default, only admins can create webs in the root
>
>
 

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
Changed:
<
<
  • Preferences are used as TWikiVariables by enclosing the name in percent signs: %. Example:
>
>
  • Preferences are used as TWikiVariables by enclosing the name in percent signs: %. Example:
 
    • When you write variable %WEBBGCOLOR%, it gets expanded to #FFD8AA .

  • ALERT! 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.
Changed:
<
<
>
>
 

Related Topics

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

Note: Can't edit?

Revision 772006-10-16 - TWikiContributor

Line: 1 to 1
 

TWiki Site-Level Preferences

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

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

Changed:
<
<
Preference settings local to your site should be set in Main.TWikiPreferences (this topic is pointed to by {LocalSitePreferences}, which is set by the admin in the configure interface). Settings in Main.TWikiPreferences will override settings in this topic, and should be used for defining custom settings and variables.
>
>
Preference settings local to your site should be set in Main.TWikiPreferences (this topic is pointed to by {LocalSitePreferences}, which is set by the admin in the configure interface). Settings in Main.TWikiPreferences will override settings in this topic, and should be used for defining custom settings and variables.
  Read more on how to set Preferences Variables.
Line: 63 to 63
 
  • 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
Added:
>
>
    • Enable content checks before editing
    • Set WYSWIYGPLUGIN_WYSIWYGSKIN = kupu
    • Disable WYSIWYG on pages that contain complex TML. On pages that have complex TML, WYSIWYG will fall back to the default text editor.
    • Set WYSIWYG_EXCLUDE = calls
 
  • Horizontal size of text edit box: (can be overwritten by user preferences)
    • Set EDITBOXWIDTH = 70
Line: 91 to 95
 
  • Format of images when the link check box is checked: (can be overwritten by user preferences)
    • HELP 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).
Added:
>
>
 
    • Set ATTACHEDIMAGEFORMAT = \n * $comment:
      \n $name
Added:
>
>
 

TWiki Platform Settings

Line: 120 to 126
  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.
Changed:
<
<
    • #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 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.
 
Line: 137 to 143
 

E-mail Settings

Deleted:
<
<

  • TWiki administrator name (first name and last name, e.g. Fred Smith):
    • Set WIKIWEBMASTERNAME = TWiki Administrator
 
  • 'Mail this topic' mailto: link - can be included in topics, templates or skins
Line: 205 to 205
 

Plugins Settings

  • You can enable/disable Plugins using the configure interface.
Added:
>
>
  • You can also disable installed plugins in individual webs/topics by defining the %DISABLEDPLUGINS% TWiki variable to be a list of plugins to disable e.g.
    • Set DISABLEDPLUGINS = SpreadSheetPlugin,EditTablePlugin
    • Currently, %DISABLEDPLUGINS% is set to "%DISABLEDPLUGINS%"
 
Added:
>
>
 
Line: 209 to 213
 
Deleted:
<
<
    • Set DISABLEDPLUGINS = The DISABLEDPLUGINS variable is no longer supported
 
    • Set INSTALLEDPLUGINS = The INSTALLEDPLUGINS variable is no longer supported. You can set the Plugins execution order using the configure interface.
Added:
>
>
 

Rendering Shortcuts Settings

  • Line break:
Line: 220 to 224
 
  • Bullet sign:
    • Set BULLET = •
Added:
>
>
  • Vertical bar / pipe symbol:
    • Set VBAR = |
 
  • Line break and bullet with different levels of indentation:
    • Set BB =
    • Set BB2 =
        •
    • Set BB3 =
          •
    • Set BB4 =
            •
Added:
>
>
  • Hint: Above shortcuts are useful in TWiki tables where you cannot use newlines

  • Graphics used in TWiki documentation - view all images in TWikiDocGraphics, SiteDocGraphics. (There are various ways to set up common icons as text variables. This is simply one quick approach.):
    • Set H = HELP
    • Set I = IDEA!
    • Set M = MOVED TO...
    • Set N = NEW
    • Set P = REFACTOR
    • Set Q = QUESTION?
    • Set S = PICK
    • Set T = TIP
    • Set U = UPDATED
    • Set X = ALERT!
    • Set Y = DONE
 
  • Colored text: (see more StandardColors)
    You type: %RED% red text %ENDCOLOR% and %GREEN% green text %ENDCOLOR%
    You get: red text and green text
Line: 272 to 295
 
    • Set ENDCOLOR =
Deleted:
<
<
  • Graphics used in TWiki documentation - view all images in TWikiDocGraphics, SiteDocGraphics. (There are various ways to set up common icons as text variables. This is simply one quick approach.):
    • Set H = HELP
    • Set I = IDEA!
    • Set M = MOVED TO...
    • Set N = NEW
    • Set P = REFACTOR
    • Set Q = QUESTION?
    • Set S = PICK
    • Set T = TIP
    • Set U = UPDATED
    • Set X = ALERT!
    • Set Y = DONE
 

Miscellaneous Settings

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

  • Font color of non existing topic: ( default #0000FF )
    • Set NEWTOPICFONTCOLOR = #0000FF
>
>
  • Format of a NewWikiWord link:
    • default setting:
      • Set NEWLINKFORMAT = $text?
    • alternative setting:
      • #Set NEWLINKFORMAT = $text
 
  • PreviewBackground image:
    • Set PREVIEWBGIMAGE = /twiki_cstc/pub/TWiki/PreviewBackground/preview2bg.gif
Added:
>
>
  • User-friendly synonyms for MAINWEB and TWIKIWEB
    • Set USERSWEB = Main
    • Set SYSTEMWEB = TWiki
    • Set DOCWEB = TWiki
 

Access Control Settings

  • Users or groups allowed to change or rename this TWikiPreferences topic:
Changed:
<
<
>
>
  • By default, only admins can create webs in the root
 

Creating New Preference Variables

Revision 762005-08-03 - TWikiContributor

Line: 1 to 1
 

TWiki Site-Level Preferences

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

Line: 85 to 84
 
  • Format of file link when the link check box is checked: (can be overwritten by user preferences)
    • HELP NOTE: Keyword $name gets expanded to filename; $comment to comment; \t to tab (3 spaces for bullets).
Added:
>
>
<-- verbatim tag required to prevent error in Apache log; does not suppress Set -->
 
    • Set ATTACHEDFILELINKFORMAT = \n * $name: $comment
Added:
>
>
 
  • Format of images when the link check box is checked: (can be overwritten by user preferences)
    • HELP 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).
Line: 114 to 116
 
  • 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 =
Changed:
<
<
    • #Set BROADCASTMESSAGE =
      NOTE:
>
>
    • #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.
Changed:
<
<
>
>
 
    • 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.
Line: 296 to 299
 
    • Set PREVIEWBGIMAGE = /twiki_cstc/pub/TWiki/PreviewBackground/preview2bg.gif
Added:
>
>

Access Control Settings

  • Users or groups allowed to change or rename this TWikiPreferences topic:
 

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

Revision 752005-08-03 - TWikiContributor

Line: 1 to 1
 

TWiki Site-Level Preferences

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

Line: 44 to 44
 
  • 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
Changed:
<
<
  • Exclude web from a web="all" search: (Set to on for hidden webs; is overwritten by web preferences)
>
>
  • 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 =
  • Prevent automatic linking of WikiWords and acronyms (if set to on); link WikiWords (if empty); can be overwritten by web preferences:
    • Set NOAUTOLINK =

Revision 742005-08-03 - TWikiContributor

Line: 1 to 1
Changed:
<
<

TWiki Site-Level Preferences

>
>

TWiki Site-Level Preferences

 
Changed:
<
<
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).
  • ALERT! NOTE: You can lock individual settings at the site or web levels using User & Group Access Control - see section below.
>
>
This topic defines site-level settings that apply to all users and webs on this TWikiSite.

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

Preference settings local to your site should be set in Main.TWikiPreferences (this topic is pointed to by {LocalSitePreferences}, which is set by the admin in the configure interface). Settings in Main.TWikiPreferences will override settings in this topic, and should be used for defining custom settings and variables.

 
Added:
>
>
Read more on how to set Preferences Variables.
 
Added:
>
>
(Click for form-based editing of existing preferences.)

 

Default Web Preferences

Changed:
<
<
ALERT! NOTE: They are typically redefined in individual WebPreferences topics
>
>
ALERT! NOTE: These are just defaults; don't change them here. Instead, add them to the WebPreferences topic in each web
 
Changed:
<
<
  • List of selected topics in a web - the second line of the upper toolbar (usually overwritten in individual WebPreferences):
>
>
  • List of selected topics in a web (used in menus)
 
Changed:
<
<
  • Web specific background color: (is overwritten by web preferences)
>
>
  • Web-specific background color: (is overwritten by web preferences)
 
    • Set WEBBGCOLOR = #FFD8AA
Added:
>
>

  • 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
    • Set SITEMAPWHAT = Describe what this web does.
    • Set SITEMAPUSETO = ...to do something.
 
  • Copyright notice:
Changed:
<
<
    • 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 WEBCOPYRIGHT = This site is powered by the TWiki collaboration platformCopyright © 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
 
Changed:
<
<
  • Simplified Copyright notice for the WebRss feed (don't use any special characters, xml tags or WikiWords)
>
>
  • 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)
Line: 29 to 50
 
    • 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.
Changed:
<
<
  • Warn if %INCLUDE{}% of topic fails: Fail silently (if empty or off); output "Warning: Can't INCLUDE Topic, topic not found" (if set to on); else, output specific text (use $topic for topic). You can override this setting by web preferences and by a warn="..." parameter in %INCLUDE{}% :
    • Set INCLUDEWARNING = Note: Included topic $topic does not exist yet
>
>
  • 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

Line: 41 to 62
 
    • Set LINKTOOLTIPINFO = off
    • #Set LINKTOOLTIPINFO = $username - $date - $rev: $summary
Added:
>
>
  • 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

  • Vertical size of text edit box: (can be overwritten by user preferences)
Changed:
<
<
    • Set EDITBOXHEIGHT = 15
>
>
    • Set EDITBOXHEIGHT = 22
 
  • 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%
Changed:
<
<
  • 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 Force New Revision (ForceNewRevision) check box in preview. Check box is initially checked if Set FORCENEWREVISIONCHECKBOX = checked="checked", or unchecked if empty: (can be overwritten by user preferences)
    • Set FORCENEWREVISIONCHECKBOX =
 
  • 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 =
Line: 61 to 85
 
  • Format of file link when the link check box is checked: (can be overwritten by user preferences)
    • HELP NOTE: Keyword $name gets expanded to filename; $comment to comment; \t to tab (3 spaces for bullets).
Changed:
<
<
    • Set ATTACHEDFILELINKFORMAT = \t* $name: $comment
>
>
    • Set ATTACHEDFILELINKFORMAT = \n * $name: $comment
 
  • Format of images when the link check box is checked: (can be overwritten by user preferences)
Changed:
<
<
    • HELP 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).
      * Set ATTACHEDIMAGEFORMAT = \t* $comment: <br />
        <img src="%ATTACHURLPATH%/$name" alt="$comment" $size />
>
>
    • HELP 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 $name
 

TWiki Platform Settings

  • TWiki site name:
    • Set WIKITOOLNAME = TWiki
Changed:
<
<
  • Image, URL and alternate tooltip text of TWiki logo: (can be overwritten by web preferences)
    • Set WIKILOGOIMG = twikiRobot46x50.gif
>
>
  • 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 = T-logo-140x40-t.gif
 
Changed:
<
<
    • Set WIKILOGOALT = TWiki home
>
>
    • Set WIKILOGOALT = Powered by TWiki
 
Changed:
<
<
  • List of TWiki webs - on the first line of the upper toolbar (to add a new web, see ManagingWebs and SiteMap):
>
>
  • Home page of this site
    • Set WIKIHOMEURL = /twiki_cstc/bin/view

  • 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
    • TIP NOTE: To automatically list all non-hidden webs in alphabetical order, use the %WEBLIST{}% variable instead:
Changed:
<
<
Main  |  TWiki
>
>
Main | TWiki
 
  • Maximum size of FileAttachments in KB, 0 for no limit:
    • Set ATTACHFILESIZELIMIT = 10000
Line: 92 to 115
 
  • 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:
Changed:
<
<
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.
>
>
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.
 
    • 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.
Added:
>
>
 

Search Settings

  • Default type for search, one of: keyword (for search engine like syntax), regex (for RegularExpression search), or literal (for verbatim search)
Line: 106 to 133
 
  • 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
Changed:
<
<

Email and Proxy Server Settings

>
>

E-mail Settings

 
Changed:
<
<
>
>
 
Changed:
<
<
  • TWiki webmaster name (first name and last name, e.g. Fred Smith):
>
>
  • TWiki administrator name (first name and last name, e.g. Fred Smith):
 
    • Set WIKIWEBMASTERNAME = TWiki Administrator
Deleted:
<
<
  • 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 =

  • Proxy Server. Some environments require outbound HTTP traffic to go through a proxy server. Set the host in PROXYHOST (example: proxy.your.company), and the port number in PROXYPORT (example: 8080). No proxy is used if PROXYHOST or PROXYPORT is empty.
    • Set PROXYHOST =
    • Set PROXYPORT =

Email Link Settings

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

  • URL for current topic
Changed:
<
<
>
>
 

HTTP-EQUIV Settings

Changed:
<
<
>
>
  • TIP 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.
  • NOTE: The current values of these preferences are not displayed in view mode (values are <link>-tags).
 
  • http-equiv meta tags for view, rdiff, attach, search* scripts:
Deleted:
<
<
 
    • #Set HTTP_EQUIV_ON_VIEW =
Changed:
<
<
    • Set HTTP_EQUIV_ON_VIEW =
>
>
    • Set HTTP_EQUIV_ON_VIEW =
 
  • http-equiv meta tags for edit script:
Deleted:
<
<
 
    • Set HTTP_EQUIV_ON_EDIT =
Deleted:
<
<
 
  • http-equiv meta tags for preview script:
Deleted:
<
<
 
    • Set HTTP_EQUIV_ON_PREVIEW =
Deleted:
<
<
 

Skin Settings

Line: 167 to 176
 

PatternSkin

Changed:
<
<

DragonSkin

  • Theme: (gray, monochrome, tabstyle)
    • Set DS_THEME = gray
  • Quicklinks headings:
    • Set DS_QUICKLINKSHEADING =
  • Quicklinks submenu:
    • Set DS_QUICKLINKS =
>
>
  • Default TWiki styles
    • 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

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

  • PatternSkin header settings
    • Set WEBHEADERART = /twiki_cstc/pub/TWiki/PatternSkin/TWiki_header.gif
    • Set WEBHEADERBGCOLOR = #ffffff

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
    • Set EDITURL = /twiki_cstc/bin/edit/TWiki/TWikiPreferences?t=1728966562
    • Set EDITTOPIC = Edit
 

Plugins Settings

Changed:
<
<
>
>
 
Changed:
<
<

Miscellaneous Settings

>
>

Rendering Shortcuts Settings

 
  • Line break:
    • Set BR =
Line: 252 to 271
 

Changed:
<
<
  • Graphics used in TWiki documentation - view all images in TWikiDocGraphics. (There are various ways to set up common icons as text variables. This is simply one quick approach.):
    • Set H = HELP
    • Set I = IDEA!
    • Set M = MOVED TO...
    • Set N = NEW
    • Set P = REFACTOR
    • Set Q = QUESTION?
    • Set S = PICK
    • Set T = TIP
    • Set U = UPDATED
    • Set X = ALERT!
    • Set Y = DONE
>
>
  • Graphics used in TWiki documentation - view all images in TWikiDocGraphics, SiteDocGraphics. (There are various ways to set up common icons as text variables. This is simply one quick approach.):
    • Set H = HELP
    • Set I = IDEA!
    • Set M = MOVED TO...
    • Set N = NEW
    • Set P = REFACTOR
    • Set Q = QUESTION?
    • Set S = PICK
    • Set T = TIP
    • Set U = UPDATED
    • Set X = ALERT!
    • Set Y = DONE

Miscellaneous Settings

 
  • Background color of non existing topic: ( default cornsilk or #FFFFCE )
    • Set NEWTOPICBGCOLOR = #FFFFCE
Line: 275 to 296
 
    • Set PREVIEWBGIMAGE = /twiki_cstc/pub/TWiki/PreviewBackground/preview2bg.gif
Deleted:
<
<

Access Control Settings

  • Users or groups allowed to change or rename this TWikiPreferences topic: (ex: TWikiAdminGroup)

Preferences Control Settings

  • Allow topic level preferences, on or off: If set to on, topic preferences will be read, and will override any web- or site-level preferences not set as FINALPREFERENCES. By default, user preferences will override topic preferences.
    • Set READTOPICPREFS = on

  • Topic level overrides user level preferences, on or off: If set to on, topic preferences will override user preferences. The user can in turn override this behavior by setting further FINALPREFERENCES in his or her user topic.
    • Set TOPICOVERRIDESUSER = off

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

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

Line: 304 to 304
 
  • Preferences are used as TWikiVariables by enclosing the name in percent signs: %. Example:
    • When you write variable %WEBBGCOLOR%, it gets expanded to #FFD8AA .
Changed:
<
<
  • ALERT! 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.
>
>
  • ALERT! 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.
  • ALERT! 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

Changed:
<
<
>
>
 
Added:
>
>
  Note: Can't edit?
Changed:
<
<
View raw topic
>
>
View raw topic

Revision 732004-08-31 - PeterThoeny

Line: 1 to 1
 

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

Line: 161 to 161
 

Skin Settings

  • Skin overriding the default TWiki templates: (can be overwritten by WebPreferences and user preferences)
Changed:
<
<
    • #Set SKIN = pattern
>
>
    • Set SKIN = pattern
 

Revision 722004-08-30 - PeterThoeny

Line: 1 to 1
 

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

Line: 74 to 74
 

TWiki Platform Settings

  • TWiki site name:
Changed:
<
<
    • Set WIKITOOLNAME = TWikibeta
>
>
    • Set WIKITOOLNAME = TWiki
 
  • Image, URL and alternate tooltip text of TWiki logo: (can be overwritten by web preferences)
    • Set WIKILOGOIMG = twikiRobot46x50.gif

Revision 712004-08-17 - ArthurClemens

Line: 1 to 1
 

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

Line: 14 to 14
 

  • Web specific background color: (is overwritten by web preferences)
Changed:
<
<
    • Set WEBBGCOLOR = #C0C0C0
>
>
    • Set WEBBGCOLOR = #FFD8AA
 
  • 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
Line: 293 to 293
 
    • Set TOPICOVERRIDESUSER = off

  • Site-level preferences that are not allowed to be overridden by WebPreferences and user preferences:
Changed:
<
<
    • Set FINALPREFERENCES = ATTACHFILESIZELIMIT, PREVIEWBGIMAGE, WIKITOOLNAME, WIKIWEBMASTER, SMTPMAILHOST, SMTPSENDERHOST, ALLOWWEBMANAGE, READTOPICPREFS, TOPICOVERRIDESUSER, BASICSTYLETOPIC
>
>
    • Set FINALPREFERENCES = ATTACHFILESIZELIMIT, PREVIEWBGIMAGE, WIKITOOLNAME, WIKIWEBMASTER, SMTPMAILHOST, SMTPSENDERHOST, ALLOWWEBMANAGE, READTOPICPREFS, TOPICOVERRIDESUSER
 

Creating New Preference Variables

Revision 702004-08-15 - PeterThoeny

Line: 1 to 1
 

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

Line: 19 to 19
 
  • 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
Changed:
<
<
  • Simplified Copyright notice for the WebRss feed (don't use any special characters or xml tags
>
>
  • Simplified Copyright notice for the WebRss feed (don't use any special characters, xml tags 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)

Revision 692004-08-08 - PeterThoeny

Line: 1 to 1
 

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

Line: 17 to 17
 
    • Set WEBBGCOLOR = #C0C0C0

  • Copyright notice:
Changed:
<
<
    • 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 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
 
  • Simplified Copyright notice for the WebRss feed (don't use any special characters or xml tags
    • Set WEBRSSCOPYRIGHT = Copyright 2024 by contributing authors
Line: 94 to 94
 
    • #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.
Changed:
<
<
>
>
    • 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

Line: 167 to 168
 

PatternSkin

  • Using attachments for styles
Changed:
<
<
>
>
 
Deleted:
<
<
  • Using topics to define styles - these settings will override attachment style settings above -
    • Default TWiki CSS styling topics where layout and style are are defined:
    • CSS styling topics to be defined in local webs or in user topics (these can complement or override default TWiki style topics):
      • Set LAYOUTTOPIC =
      • Set STYLETOPIC =
    • Use the CSS TOPIC setting above to build the URLS used in the templates
      • #Set TWIKILAYOUTURL = ../TWiki/%TWIKILAYOUTTOPIC%?skin=text&contenttype=text/css
      • #Set TWIKISTYLEURL = ../TWiki/%TWIKISTYLETOPIC%?skin=text&contenttype=text/css
      • #Set USERLAYOUTURL = ../TWiki/%USERLAYOUTTOPIC%?skin=text&contenttype=text/css
      • #Set USERSTYLEURL = ../TWiki/%USERSTYLETOPIC%?skin=text&contenttype=text/css
 

DragonSkin

Revision 682004-08-05 - PeterThoeny

Line: 1 to 1
 

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

Line: 38 to 38
 ALERT! NOTE: They are typically redefined in topics of individual TWikiUsers

  • 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
Changed:
<
<
    • Set LINKTOOLTIPINFO = on
>
>
    • Set LINKTOOLTIPINFO = off
 
    • #Set LINKTOOLTIPINFO = $username - $date - $rev: $summary

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

Revision 672004-07-31 - PeterThoeny

Line: 1 to 1
 

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

Line: 160 to 160
 

Skin Settings

  • Skin overriding the default TWiki templates: (can be overwritten by WebPreferences and user preferences)
Changed:
<
<
    • Set SKIN =
>
>
    • #Set SKIN = pattern
 
Added:
>
>

PatternSkin

  • Using topics to define styles - these settings will override attachment style settings above -
 
  • Default TWiki CSS styling topics where layout and style are are defined:
Line: 175 to 183
 
    • #Set USERLAYOUTURL = ../TWiki/%USERLAYOUTTOPIC%?skin=text&contenttype=text/css
    • #Set USERSTYLEURL = ../TWiki/%USERSTYLETOPIC%?skin=text&contenttype=text/css
Added:
>
>

DragonSkin

  • Theme: (gray, monochrome, tabstyle)
    • Set DS_THEME = gray
  • Quicklinks headings:
    • Set DS_QUICKLINKSHEADING =
  • Quicklinks submenu:
    • Set DS_QUICKLINKS =
 

Plugins Settings

Revision 662004-07-30 - PeterThoeny

Line: 1 to 1
 

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

Line: 73 to 73
 

TWiki Platform Settings

Changed:
<
<
  • TWiki platform name:
>
>
  • TWiki site name:
 
    • Set WIKITOOLNAME = TWikibeta

  • Image, URL and alternate tooltip text of TWiki logo: (can be overwritten by web preferences)
Line: 82 to 82
 
    • 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):
Changed:
<
<
>
>
 
    • TIP NOTE: To automatically list all non-hidden webs in alphabetical order, use the %WEBLIST{}% variable instead:
      Main  |  TWiki
Changed:
<
<
  • Skin overriding the default TWiki templates: (can be overwritten by WebPreferences and user preferences)
    • Set SKIN =
>
>
  • 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 =
Line: 95 to 95
  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.
Deleted:
<
<
  • Maximum size of FileAttachments in KB, 0 for no limit:
    • Set ATTACHFILESIZELIMIT = 10000
 

Search Settings

Line: 144 to 142
 
  • http-equiv meta tags for view, rdiff, attach, search* scripts:
Changed:
<
<
    • Set HTTP_EQUIV_ON_VIEW =
>
>
    • #Set HTTP_EQUIV_ON_VIEW =
    • Set HTTP_EQUIV_ON_VIEW =
 

  • http-equiv meta tags for edit script:
Line: 158 to 157
 
Added:
>
>

Skin Settings

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

  • Default TWiki CSS styling topics where layout and style are are defined:
  • CSS styling topics to be defined in local webs or in user topics (these can complement or override default TWiki style topics):
    • Set LAYOUTTOPIC =
    • Set STYLETOPIC =

  • Use the CSS TOPIC setting above to build the URLS used in the templates
    • #Set TWIKILAYOUTURL = ../TWiki/%TWIKILAYOUTTOPIC%?skin=text&contenttype=text/css
    • #Set TWIKISTYLEURL = ../TWiki/%TWIKISTYLETOPIC%?skin=text&contenttype=text/css
    • #Set USERLAYOUTURL = ../TWiki/%USERLAYOUTTOPIC%?skin=text&contenttype=text/css
    • #Set USERSTYLEURL = ../TWiki/%USERSTYLETOPIC%?skin=text&contenttype=text/css
 

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.
Line: 199 to 217
 
    • Set GREEN = looks like this
    • Set OLIVE = looks like this
    • Set MAROON = looks like this
Added:
>
>
    • Set BROWN = looks like this
 
    • Set BLACK = looks like this
    • Set GRAY = looks like this
    • Set SILVER = looks like this
Line: 218 to 237
 
    • Set GREEN =
    • Set OLIVE =
    • Set MAROON =
Added:
>
>
    • Set BROWN =
 
    • Set BLACK =
    • Set GRAY =
    • Set SILVER =
Line: 267 to 287
 
    • Set TOPICOVERRIDESUSER = off

  • Site-level preferences that are not allowed to be overridden by WebPreferences and user preferences:
Changed:
<
<
    • Set FINALPREFERENCES = ATTACHFILESIZELIMIT, PREVIEWBGIMAGE, WIKITOOLNAME, WIKIWEBMASTER, SMTPMAILHOST, SMTPSENDERHOST, ALLOWWEBMANAGE, READTOPICPREFS, TOPICOVERRIDESUSER
>
>
    • Set FINALPREFERENCES = ATTACHFILESIZELIMIT, PREVIEWBGIMAGE, WIKITOOLNAME, WIKIWEBMASTER, SMTPMAILHOST, SMTPSENDERHOST, ALLOWWEBMANAGE, READTOPICPREFS, TOPICOVERRIDESUSER, BASICSTYLETOPIC
 

Creating New Preference Variables

Revision 652004-04-26 - PeterThoeny

Line: 1 to 1
 

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

Line: 17 to 17
 
    • Set WEBBGCOLOR = #C0C0C0

  • Copyright notice:
Changed:
<
<
    • 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 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.
 
  • Simplified Copyright notice for the WebRss feed (don't use any special characters or xml tags
    • Set WEBRSSCOPYRIGHT = Copyright 2024 by contributing authors

Revision 642004-04-25 - PeterThoeny

Line: 1 to 1
 

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

Line: 37 to 37
  ALERT! NOTE: They are typically redefined in topics of individual TWikiUsers
Added:
>
>
  • 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 = on
    • #Set LINKTOOLTIPINFO = $username - $date - $rev: $summary
 
  • Horizontal size of text edit box: (can be overwritten by user preferences)
    • Set EDITBOXWIDTH = 70

Revision 632004-02-28 - ArthurClemens

Line: 1 to 1
 

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

Line: 63 to 63
 
    • HELP 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).
      * Set ATTACHEDIMAGEFORMAT = \t* $comment: <br />
Changed:
<
<
$name
>
>
$comment
 

Revision 622004-02-21 - PeterThoeny

Line: 1 to 1
 

TWiki Site-Level Preferences

Changed:
<
<
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: TWikiGuest).
>
>
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).
 
  • ALERT! NOTE: You can lock individual settings at the site or web levels using User & Group Access Control - see section below.
Line: 19 to 19
 
  • 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.
Added:
>
>
  • Simplified Copyright notice for the WebRss feed (don't use any special characters or xml tags
    • 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 NOSEARCHALL =
Line: 251 to 254
 
Added:
>
>

Preferences Control Settings

  • Allow topic level preferences, on or off: If set to on, topic preferences will be read, and will override any web- or site-level preferences not set as FINALPREFERENCES. By default, user preferences will override topic preferences.
    • Set READTOPICPREFS = on

  • Topic level overrides user level preferences, on or off: If set to on, topic preferences will override user preferences. The user can in turn override this behavior by setting further FINALPREFERENCES in his or her user topic.
    • Set TOPICOVERRIDESUSER = off
 
  • Site-level preferences that are not allowed to be overridden by WebPreferences and user preferences:
Changed:
<
<
    • Set FINALPREFERENCES = ATTACHFILESIZELIMIT, PREVIEWBGIMAGE, WIKITOOLNAME, WIKIWEBMASTER, SMTPMAILHOST, SMTPSENDERHOST, ALLOWWEBMANAGE
>
>
    • Set FINALPREFERENCES = ATTACHFILESIZELIMIT, PREVIEWBGIMAGE, WIKITOOLNAME, WIKIWEBMASTER, SMTPMAILHOST, SMTPSENDERHOST, ALLOWWEBMANAGE, READTOPICPREFS, TOPICOVERRIDESUSER
 

Creating New Preference Variables

Revision 612004-02-10 - PeterThoeny

Line: 1 to 1
 

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

Line: 106 to 106
 

  • TWiki webmaster name (first name and last name, e.g. Fred Smith):
Changed:
<
<
    • Set WIKIWEBMASTERNAME = TWiki Webmaster
>
>
    • Set WIKIWEBMASTERNAME = TWiki Administrator
 
  • 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

Revision 602004-01-08 - PeterThoeny

Line: 1 to 1
 

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

Line: 17 to 17
 
    • Set WEBBGCOLOR = #C0C0C0

  • Copyright notice:
Changed:
<
<
    • Set WEBCOPYRIGHT = Copyright © 1999-2003 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 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.
 
  • Exclude web from a web="all" search: (Set to on for hidden webs; is overwritten by web preferences)
    • Set NOSEARCHALL =

Revision 592004-01-04 - PeterThoeny

Line: 1 to 1
 

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

Line: 6 to 6
 
Changed:
<
<

Web Preferences

>
>

Default Web Preferences

  ALERT! NOTE: They are typically redefined in individual WebPreferences topics
Line: 30 to 30
 
    • Set INCLUDEWARNING = Note: Included topic $topic does not exist yet
Changed:
<
<

User Settings

>
>

Default User Settings

  ALERT! NOTE: They are typically redefined in topics of individual TWikiUsers
Line: 91 to 91
 
  • Maximum size of FileAttachments in KB, 0 for no limit:
    • Set ATTACHFILESIZELIMIT = 10000
Changed:
<
<

Email and Proxy Server Settings

>
>

Search Settings

  • Default type for search, one of: keyword (for search engine like syntax), regex (for RegularExpression search), or literal (for verbatim search)
    • Set SEARCHDEFAULTTTYPE = keyword
  • 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:
    • 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

Email and Proxy Server Settings

 
Line: 122 to 131
 
Changed:
<
<

Plugins Settings

HTTP-EQUIV Settings

>
>

HTTP-EQUIV Settings

 
Line: 152 to 151
 
Added:
>
>

Plugins Settings

 

Miscellaneous Settings

  • Line break:

Revision 582003-12-26 - PeterThoeny

Line: 1 to 1
 

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

Line: 88 to 88
  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.
Added:
>
>
  • Maximum size of FileAttachments in KB, 0 for no limit:
    • Set ATTACHFILESIZELIMIT = 10000
 

Email and Proxy Server Settings

  • TWiki webmaster email address:
Line: 241 to 244
 

  • Site-level preferences that are not allowed to be overridden by WebPreferences and user preferences:
Changed:
<
<
    • Set FINALPREFERENCES = PREVIEWBGIMAGE, WIKITOOLNAME, WIKIWEBMASTER, SMTPMAILHOST , SMTPSENDERHOST, ALLOWWEBMANAGE
>
>
    • Set FINALPREFERENCES = ATTACHFILESIZELIMIT, PREVIEWBGIMAGE, WIKITOOLNAME, WIKIWEBMASTER, SMTPMAILHOST , SMTPSENDERHOST, ALLOWWEBMANAGE
 

Creating New Preference Variables

Revision 572003-12-20 - PeterThoeny

Line: 1 to 1
 

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

Line: 235 to 235
 
  • Users or groups allowed to change or rename this TWikiPreferences topic: (ex: TWikiAdminGroup)
    • Set ALLOWTOPICCHANGE =
Changed:
<
<
    • Set ALLOWTOPICRENAME =
>
>
 

Revision 562003-12-16 - PeterThoeny

Line: 1 to 1
 

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

Line: 83 to 83
 
    • Set SKIN =

  • 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)
Changed:
<
<
    • #Set BROADCASTMESSAGE =
    • Set BROADCASTMESSAGE =
      NOTE:
>
>
    • 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.
Line: 130 to 130
 

HTTP-EQUIV Settings

Added:
>
>
 
  • http-equiv meta tags for view, rdiff, attach, search* scripts:
      * Set HTTP_EQUIV_ON_VIEW = 
Changed:
<
<
  • 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">
>
>
  • http-equiv meta tags for edit script:
 
      * Set HTTP_EQUIV_ON_EDIT = 
Line: 154 to 157
 
  • Bullet sign:
    • Set BULLET = •
Changed:
<
<
  • Line break and bullet: (useful in table cells)
>
>
  • Line break and bullet with different levels of indentation:
 
    • Set BB =
Added:
>
>
    • 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
    • Note: %<color>% text must end with %ENDCOLOR% . If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%.
Added:
>
>
<-- Two sets of colors follow: Color test and color setting -->
    • Set YELLOW = looks like this
    • Set ORANGE = looks like this
    • Set RED = looks like this
    • Set PINK = looks like this
    • Set PURPLE = looks like this
    • Set TEAL = looks like this
    • Set NAVY = looks like this
    • Set BLUE = looks like this
    • Set AQUA = looks like this
    • Set LIME = looks like this
    • Set GREEN = looks like this
    • Set OLIVE = looks like this
    • Set MAROON = looks like this
    • Set BLACK = looks like this
    • Set GRAY = looks like this
    • Set SILVER = looks like this
    • Set WHITE = looks like this (with gray background)
    • The following color settings are enclosed in verbatim tags to avoid incorrect nesting of XHTML tags:
 
    • Set YELLOW =
Deleted:
<
<
      • YELLOW looks like this
 
    • Set ORANGE =
Deleted:
<
<
      • ORANGE looks like this
 
    • Set RED =
Deleted:
<
<
      • RED looks like this
 
    • Set PINK =
Deleted:
<
<
      • PINK looks like this
 
    • Set PURPLE =
Deleted:
<
<
      • PURPLE looks like this
 
    • Set TEAL =
Deleted:
<
<
      • TEAL looks like this
 
    • Set NAVY =
Deleted:
<
<
      • NAVY looks like this
 
    • Set BLUE =
Deleted:
<
<
      • BLUE looks like this
 
    • Set AQUA =
Deleted:
<
<
      • AQUA looks like this
 
    • Set LIME =
Deleted:
<
<
      • LIME looks like this
 
    • Set GREEN =
Deleted:
<
<
      • GREEN looks like this
 
    • Set OLIVE =
Deleted:
<
<
      • OLIVE looks like this
 
    • Set MAROON =
Deleted:
<
<
      • MAROON looks like this
 
    • Set BLACK =
Deleted:
<
<
      • BLACK looks like this
 
    • Set GRAY =
Deleted:
<
<
      • GRAY looks like this
 
    • Set SILVER =
Deleted:
<
<
      • SILVER looks like this
 
    • Set WHITE =
Deleted:
<
<
      • WHITE looks like this
    • And finally:
 
    • Set ENDCOLOR =
Changed:
<
<
      • To finish colored text
>
>
 
  • Graphics used in TWiki documentation - view all images in TWikiDocGraphics. (There are various ways to set up common icons as text variables. This is simply one quick approach.):

Revision 552003-12-12 - PeterThoeny

Line: 1 to 1
 

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

Line: 122 to 122
 

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

Revision 542003-10-12 - PeterThoeny

Line: 1 to 1
 

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

Line: 82 to 82
 
  • Skin overriding the default TWiki templates: (can be overwritten by WebPreferences and user preferences)
    • Set SKIN =
Added:
>
>
  • 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.
 

Email and Proxy Server Settings

Revision 532003-08-23 - PeterThoeny

Line: 1 to 1
 

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

Line: 26 to 26
 
    • 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.
Changed:
<
<
  • Warn if %INCLUDE{}% of other topic fails (if set to on); silently fail (if empty); can be overwritten by web preferences:
    • Set INCLUDEWARNING =
>
>
  • Warn if %INCLUDE{}% of topic fails: Fail silently (if empty or off); output "Warning: Can't INCLUDE Topic, topic not found" (if set to on); else, output specific text (use $topic for topic). You can override this setting by web preferences and by a warn="..." parameter in %INCLUDE{}% :
    • Set INCLUDEWARNING = Note: Included topic $topic does not exist yet
 

User Settings

Revision 522003-08-20 - PeterThoeny

Line: 1 to 1
 

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

Line: 67 to 67
 

TWiki Platform Settings

  • TWiki platform name:
Changed:
<
<
    • Set WIKITOOLNAME = TWiki
>
>
    • Set WIKITOOLNAME = TWikibeta
 
  • Image, URL and alternate tooltip text of TWiki logo: (can be overwritten by web preferences)
    • Set WIKILOGOIMG = twikiRobot46x50.gif

Revision 512003-08-10 - PeterThoeny

Line: 1 to 1
 

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

Line: 88 to 88
 
Added:
>
>
  • TWiki webmaster name (first name and last name, e.g. Fred Smith):
    • Set WIKIWEBMASTERNAME = TWiki Webmaster
 
  • 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

Revision 502003-07-30 - PeterThoeny

Line: 1 to 1
 

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

Line: 26 to 26
 
    • 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.
Added:
>
>
  • Warn if %INCLUDE{}% of other topic fails (if set to on); silently fail (if empty); can be overwritten by web preferences:
    • Set INCLUDEWARNING =
 

User Settings

Revision 492003-06-07 - PeterThoeny

Line: 1 to 1
 

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

Line: 143 to 143
 
  • Bullet sign:
    • Set BULLET = •
Added:
>
>
  • Line break and bullet: (useful in table cells)
    • Set BB =
 
  • Colored text: (see more StandardColors)
    You type: %RED% red text %ENDCOLOR% and %GREEN% green text %ENDCOLOR%
    You get: red text and green text

Revision 482003-02-03 - PeterThoeny

Line: 1 to 1
 

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

Line: 239 to 239
 
Added:
>
>
Note: Can't edit? View raw topic

Revision 472003-02-02 - PeterThoeny

Line: 1 to 1
 

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

Line: 64 to 64
 

TWiki Platform Settings

  • TWiki platform name:
Changed:
<
<
    • Set WIKITOOLNAME = TWikibeta
>
>
    • Set WIKITOOLNAME = TWiki
 
  • Image, URL and alternate tooltip text of TWiki logo: (can be overwritten by web preferences)
    • Set WIKILOGOIMG = twikiRobot46x50.gif

Revision 462003-01-25 - PeterThoeny

Line: 1 to 1
 

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

Line: 185 to 185
 
    • Set ENDCOLOR =
      • To finish colored text
Added:
>
>
 
  • Graphics used in TWiki documentation - view all images in TWikiDocGraphics. (There are various ways to set up common icons as text variables. This is simply one quick approach.):
    • Set H = HELP
    • Set I = IDEA!

Revision 452003-01-19 - PeterThoeny

Line: 1 to 1
 

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

Line: 17 to 17
 
    • Set WEBBGCOLOR = #C0C0C0

  • Copyright notice:
Changed:
<
<
    • Set WEBCOPYRIGHT = Copyright © 1999-2002 by the contributing authors. \nAll material on this collaboration tool is the property of the contributing authors.
      \nIdeas, requests, problems regarding TWiki? Send feedback.
>
>
    • Set WEBCOPYRIGHT = Copyright © 1999-2003 by the contributing authors. \nAll material on this collaboration platform 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 =

Revision 442003-01-16 - PeterThoeny

Line: 1 to 1
 

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

Line: 17 to 17
 
    • Set WEBBGCOLOR = #C0C0C0

  • Copyright notice:
Changed:
<
<
    • Set WEBCOPYRIGHT = Copyright © 1999-2002 by the contributing authors. \nAll material on this collaboration tool is the property of the contributing authors.
      \nIdeas, requests, problems regarding TWiki? Send feedback.
>
>
    • Set WEBCOPYRIGHT = Copyright © 1999-2002 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 =

Revision 432002-12-31 - PeterThoeny

Line: 1 to 1
 

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

Line: 13 to 13
 
  • List of selected topics in a web - the second line of the upper toolbar (usually overwritten in individual WebPreferences):
Added:
>
>
  • Web specific background color: (is overwritten by web preferences)
    • Set WEBBGCOLOR = #C0C0C0
 
  • Copyright notice:
    • Set WEBCOPYRIGHT = Copyright © 1999-2002 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 =
Changed:
<
<
  • Web specific background color: (is overwritten by web preferences)
    • Set WEBBGCOLOR = #C0C0C0
>
>
  • Prevent automatic linking of WikiWords and acronyms (if set to on); link WikiWords (if empty); can be 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.
 

User Settings

Revision 422002-11-02 - PeterThoeny

Line: 1 to 1
 

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

Line: 136 to 136
 
  • Line break:
    • Set BR =
Added:
>
>
  • Bullet sign:
    • Set BULLET = •
 
  • Colored text: (see more StandardColors)
    You type: %RED% red text %ENDCOLOR% and %GREEN% green text %ENDCOLOR%
    You get: red text and green text

Revision 412002-10-03 - PeterThoeny

Line: 1 to 1
 

TWiki Site-Level Preferences

Changed:
<
<
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).
>
>
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: TWikiGuest).
 
  • ALERT! NOTE: You can lock individual settings at the site or web levels using User & Group Access Control - see section below.

Revision 402002-08-25 - PeterThoeny

Line: 1 to 1
 

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

Line: 198 to 198
 
    • Set NEWTOPICFONTCOLOR = #0000FF

Changed:
<
<
    • Set PREVIEWBGIMAGE = /twiki_cstc/pub/TWiki/PreviewBackground/previewbg.gif
>
>
    • Set PREVIEWBGIMAGE = /twiki_cstc/pub/TWiki/PreviewBackground/preview2bg.gif
 

Access Control Settings

Revision 392002-08-22 - PeterThoeny

Line: 1 to 1
 

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

Line: 72 to 72
 
    • TIP NOTE: To automatically list all non-hidden webs in alphabetical order, use the %WEBLIST{}% variable instead:
      Main  |  TWiki
Added:
>
>
  • Skin overriding the default TWiki templates: (can be overwritten by WebPreferences and user preferences)
    • Set SKIN =
 

Email and Proxy Server Settings

Line: 92 to 95
 

Email Link Settings

  • 'Mail this topic' mailto: link - can be included in topics, templates or skins
Changed:
<
<
>
>
 
  • 'Mail this topic' link text
    • Set MAILTHISTOPICTEXT = Send a link to this page
Line: 133 to 136
 
  • Line break:
    • Set BR =
Deleted:
<
<
  • Graphics used in TWiki documentation - view all images in TWikiDocGraphics. (There are various ways to set up common icons as text variables. This is simply one quick approach.):
    • Set H = HELP
    • Set I = IDEA!
    • Set M = MOVED TO...
    • Set N = NEW
    • Set P = REFACTOR
    • Set Q = QUESTION?
    • Set S = PICK
    • Set T = TIP
    • Set U = UPDATED
    • Set X = ALERT!
    • Set Y = DONE
 
  • Colored text: (see more StandardColors)
    You type: %RED% red text %ENDCOLOR% and %GREEN% green text %ENDCOLOR%
    You get: red text and green text
    • Note: %<color>% text must end with %ENDCOLOR% . If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%.
    • Set YELLOW =
      • YELLOW looks like this
Added:
>
>
    • Set ORANGE =
      • ORANGE looks like this
 
    • Set RED =
      • RED looks like this
    • Set PINK =
Line: 182 to 174
 
      • SILVER looks like this
    • Set WHITE =
      • WHITE looks like this
Changed:
<
<
    • And finally:
>
>
    • And finally:
 
    • Set ENDCOLOR =
      • To finish colored text
Added:
>
>
  • Graphics used in TWiki documentation - view all images in TWikiDocGraphics. (There are various ways to set up common icons as text variables. This is simply one quick approach.):
    • Set H = HELP
    • Set I = IDEA!
    • Set M = MOVED TO...
    • Set N = NEW
    • Set P = REFACTOR
    • Set Q = QUESTION?
    • Set S = PICK
    • Set T = TIP
    • Set U = UPDATED
    • Set X = ALERT!
    • Set Y = DONE
 
  • Background color of non existing topic: ( default cornsilk or #FFFFCE )
    • Set NEWTOPICBGCOLOR = #FFFFCE

Revision 382002-08-02 - PeterThoeny

Line: 1 to 1
 

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

Line: 73 to 73
  Main  |  TWiki
Changed:
<
<

Email Settings

>
>

Email and Proxy Server Settings

 
Line: 84 to 84
 
  • 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 =
Added:
>
>
  • Proxy Server. Some environments require outbound HTTP traffic to go through a proxy server. Set the host in PROXYHOST (example: proxy.your.company), and the port number in PROXYPORT (example: 8080). No proxy is used if PROXYHOST or PROXYPORT is empty.
    • Set PROXYHOST =
    • Set PROXYPORT =
 

Email Link Settings

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

Revision 372002-07-12 - PeterThoeny

Line: 1 to 1
 

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

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

 
Deleted:
<
<

General Preferences

 
Changed:
<
<
  • 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  |  Know  |  Sandbox
    • TIP NOTE: To automatically list all non-hidden webs in alphabetical order, use the %WEBLIST{}% variable instead:
      Main  |  TWiki
>
>

Web Preferences

ALERT! NOTE: They are typically redefined in individual WebPreferences topics

 
  • List of selected topics in a web - the second line of the upper toolbar (usually overwritten in individual WebPreferences):
Changed:
<
<
>
>
 
  • Copyright notice:
    • Set WEBCOPYRIGHT = Copyright © 1999-2002 by the contributing authors. \nAll material on this collaboration tool is the property of the contributing authors.
      \nIdeas, requests, problems regarding TWiki? Send feedback.
Line: 25 to 22
 
  • Web specific background color: (is overwritten by web preferences)
    • Set WEBBGCOLOR = #C0C0C0
Deleted:
<
<
  • PreviewBackground image:
    • Set PREVIEWBGIMAGE = /twiki_cstc/pub/TWiki/PreviewBackground/previewbg.gif
 
Changed:
<
<
  • Background color of non existing topic: ( default cornsilk or #FFFFCE )
    • Set NEWTOPICBGCOLOR = #FFFFCE
>
>

User Settings

 
Changed:
<
<
  • Font color of non existing topic: ( default #0000FF )
    • Set NEWTOPICFONTCOLOR = #0000FF
>
>
ALERT! NOTE: They are typically redefined in topics of individual TWikiUsers
 
  • Horizontal size of text edit box: (can be overwritten by user preferences)
    • Set EDITBOXWIDTH = 70
Line: 63 to 56
  $name
Added:
>
>

TWiki Platform Settings

  • TWiki platform name:
    • Set WIKITOOLNAME = TWikibeta

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

  • 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  |  Know  |  Sandbox
    • TIP NOTE: To automatically list all non-hidden webs in alphabetical order, use the %WEBLIST{}% variable instead:
      Main  |  TWiki
 

Email Settings

  • TWiki webmaster email address:
Line: 74 to 84
 
  • 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 =
Added:
>
>

Email Link 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

 

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.
Line: 116 to 140
 
    • Set U = UPDATED
    • Set X = ALERT!
    • Set Y = DONE
Deleted:
<
<
    • Set TLS = TWiki ID button
 
  • Colored text: (see more StandardColors)
    You type: %RED% red text %ENDCOLOR% and %GREEN% green text %ENDCOLOR%
Line: 158 to 181
 
    • Set ENDCOLOR =
      • To finish colored text
Added:
>
>
  • Background color of non existing topic: ( default cornsilk or #FFFFCE )
    • Set NEWTOPICBGCOLOR = #FFFFCE

  • Font color of non existing topic: ( default #0000FF )
    • Set NEWTOPICFONTCOLOR = #0000FF

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

Access Control Settings

  • Users or groups allowed to change or rename this TWikiPreferences topic: (ex: TWikiAdminGroup)
Line: 168 to 201
 

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

Creating New Preference Variables

Revision 362002-06-24 - PeterThoeny

Line: 1 to 1
 

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

Line: 101 to 101
 

Miscellaneous Settings

Added:
>
>
  • Line break:
    • Set BR =
 
  • Graphics used in TWiki documentation - view all images in TWikiDocGraphics. (There are various ways to set up common icons as text variables. This is simply one quick approach.):
    • Set H = HELP
    • Set I = IDEA!

Revision 352002-06-15 - PeterThoeny

Line: 1 to 1
 

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

Line: 9 to 9
 

General Preferences

  • List of TWiki webs - on the first line of the upper toolbar (to add a new web, see ManagingWebs and SiteMap):
Changed:
<
<
    • Set WIKIWEBLIST = Main  |  TWiki  |  Know  |  Sandbox
    • TIP NOTE: To automatically list all non-hidden webs in alphabetical order, use this variable instead:
      Set WIKIWEBLIST = Main  |  TWiki
>
>
    • Set WIKIWEBLIST = Main  |  TWiki  |  Know  |  Sandbox
    • TIP NOTE: To automatically list all non-hidden webs in alphabetical order, use the %WEBLIST{}% variable instead:
      Main  |  TWiki
 
  • List of selected topics in a web - the second line of the upper toolbar (usually overwritten in individual WebPreferences):

Revision 342002-06-05 - PeterThoeny

Line: 1 to 1
 

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

Line: 39 to 39
 
  • Vertical size of text edit box: (can be overwritten by user preferences)
    • Set EDITBOXHEIGHT = 15
Changed:
<
<
  • Style of text edit box. Set to width: 100% 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: 100%
>
>
  • 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 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 =

Revision 332002-06-01 - PeterThoeny

Line: 1 to 1
 

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

Line: 39 to 39
 
  • Vertical size of text edit box: (can be overwritten by user preferences)
    • Set EDITBOXHEIGHT = 15
Changed:
<
<
  • Style of text edit box. Set to width: 100% for full window width (which will overwrite the EDITBOXWIDTH setting), or width: auto to disable (default). This setting works for IE and some other recent browsers. (can be overwritten by user preferences)
    • Set EDITBOXSTYLE = width: auto
>
>
  • Style of text edit box. Set to width: 100% 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: 100%
 
  • 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 =

Revision 322002-05-31 - PeterThoeny

Line: 1 to 1
Changed:
<
<

TWiki Site-Level 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), and on the user level (create preferences in your user account topic in the Main web, ex: Main.guest).
  • ALERT! NOTE: You can lock individual settings at the site or web levels using User & Group Access Control - see section below.
Line: 38 to 39
 
  • Vertical size of text edit box: (can be overwritten by user preferences)
    • Set EDITBOXHEIGHT = 15
Added:
>
>
  • Style of text edit box. Set to width: 100% for full window width (which will overwrite the EDITBOXWIDTH setting), or width: auto to disable (default). This setting works for IE and some other recent browsers. (can be overwritten by user preferences)
    • Set EDITBOXSTYLE = width: auto
 
  • 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 =

Revision 312002-05-24 - PeterThoeny

Line: 1 to 1
 

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).
  • ALERT! NOTE: You can lock individual settings at the site or web levels using User & Group Access Control - see section below.
Line: 150 to 150
 
    • Set ENDCOLOR =
      • To finish colored text
Changed:
<
<

Preferences Access Control

>
>

Access Control Settings

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

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

Creating New Preference Variables

Revision 302002-04-21 - PeterThoeny

Line: 1 to 1
 

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).
  • ALERT! NOTE: You can lock individual settings at the site or web levels using User & Group Access Control - see section below.
Line: 8 to 8
 

General Preferences

  • List of TWiki webs - on the first line of the upper toolbar (to add a new web, see ManagingWebs and SiteMap):
Changed:
<
<
>
>
 
    • TIP NOTE: To automatically list all non-hidden webs in alphabetical order, use this variable instead:
      Set WIKIWEBLIST = Main  |  TWiki

  • List of selected topics in a web - the second line of the upper toolbar (usually overwritten in individual WebPreferences):

Revision 292002-04-14 - PeterThoeny

Line: 1 to 1
 

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).
  • ALERT! NOTE: You can lock individual settings at the site or web levels using User & Group Access Control - see section below.
Line: 96 to 96
 

Miscellaneous Settings

Added:
>
>
  • Graphics used in TWiki documentation - view all images in TWikiDocGraphics. (There are various ways to set up common icons as text variables. This is simply one quick approach.):
    • Set H = HELP
    • Set I = IDEA!
    • Set M = MOVED TO...
    • Set N = NEW
    • Set P = REFACTOR
    • Set Q = QUESTION?
    • Set S = PICK
    • Set T = TIP
    • Set U = UPDATED
    • Set X = ALERT!
    • Set Y = DONE
    • Set TLS = TWiki ID button
 
  • Colored text: (see more StandardColors)
    You type: %RED% red text %ENDCOLOR% and %GREEN% green text %ENDCOLOR%
    You get: red text and green text

Revision 282002-04-13 - PeterThoeny

Line: 1 to 1
 

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).
  • ALERT! NOTE: You can lock individual settings at the site or web levels using User & Group Access Control - see section below.
Line: 142 to 142
 
    • Set ALLOWTOPICCHANGE =
    • Set ALLOWTOPICRENAME =
Added:
>
>
 
  • Site-level preferences that are not allowed to be overridden by WebPreferences and user preferences:
Changed:
<
<
    • Set FINALPREFERENCES = PREVIEWBGIMAGE, WIKIWEBMASTER, SMTPMAILHOST , SMTPSENDERHOST
>
>
    • Set FINALPREFERENCES = PREVIEWBGIMAGE, WIKIWEBMASTER, SMTPMAILHOST , SMTPSENDERHOST, ALLOWWEBCREATEWEB
 

Creating New Preference Variables

Revision 272002-04-07 - PeterThoeny

Line: 1 to 1
 

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).
  • ALERT! NOTE: You can lock individual settings at the site or web levels using User & Group Access Control - see section below.
Line: 7 to 7
 

General Preferences

Changed:
<
<
>
>
  • 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  |  Know  |  Test
    • TIP NOTE: To automatically list all non-hidden webs in alphabetical order, use this variable instead:
      Set WIKIWEBLIST = Main  |  TWiki

Revision 262002-02-22 - PeterThoeny

Line: 1 to 1
 

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).
  • ALERT! NOTE: You can lock individual settings at the site or web levels using User & Group Access Control - see section below.

Changed:
<
<

General Preferences:

>
>

General Preferences

 
Line: 94 to 94
 
    • Set HTTP_EQUIV_ON_PREVIEW =
Added:
>
>

Miscellaneous Settings

  • Colored text: (see more StandardColors)
    You type: %RED% red text %ENDCOLOR% and %GREEN% green text %ENDCOLOR%
    You get: red text and green text
    • Note: %<color>% text must end with %ENDCOLOR% . If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%.
    • Set YELLOW =
      • YELLOW looks like this
    • Set RED =
      • RED looks like this
    • Set PINK =
      • PINK looks like this
    • Set PURPLE =
      • PURPLE looks like this
    • Set TEAL =
      • TEAL looks like this
    • Set NAVY =
      • NAVY looks like this
    • Set BLUE =
      • BLUE looks like this
    • Set AQUA =
      • AQUA looks like this
    • Set LIME =
      • LIME looks like this
    • Set GREEN =
      • GREEN looks like this
    • Set OLIVE =
      • OLIVE looks like this
    • Set MAROON =
      • MAROON looks like this
    • Set BLACK =
      • BLACK looks like this
    • Set GRAY =
      • GRAY looks like this
    • Set SILVER =
      • SILVER looks like this
    • Set WHITE =
      • WHITE looks like this
    • And finally:
    • Set ENDCOLOR =
      • To finish colored text
 

Preferences Access Control

  • Users or groups allowed to change or rename this TWikiPreferences topic: (ex: TWikiAdminGroup)

Revision 252002-01-04 - PeterThoeny

Line: 1 to 1
 

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).
  • ALERT! NOTE: You can lock individual settings at the site or web levels using User & Group Access Control - see section below.
Line: 15 to 15
 

  • Copyright notice:
Changed:
<
<
    • 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.
>
>
    • Set WEBCOPYRIGHT = Copyright © 1999-2002 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 =

Revision 242002-01-01 - PeterThoeny

Line: 1 to 1
 

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).
  • ALERT! NOTE: You can lock individual settings at the site or web levels using User & Group Access Control - see section below.
Line: 48 to 48
 
    • Set ATTACHLINKBOX =

  • Format of file link when the link check box is checked: (can be overwritten by user preferences)
Deleted:
<
<
    • Set ATTACHEDFILELINKFORMAT = \t* $name: $comment
 
    • HELP NOTE: Keyword $name gets expanded to filename; $comment to comment; \t to tab (3 spaces for bullets).
Added:
>
>
    • Set ATTACHEDFILELINKFORMAT = \t* $name: $comment
 
  • Format of images when the link check box is checked: (can be overwritten by user preferences)
Deleted:
<
<
    • Set ATTACHEDIMAGEFORMAT = \t* $comment:
      $name
    • HELP NOTE: Example image is broken because there is no attached image file.
 
    • HELP 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).
Added:
>
>
      * Set ATTACHEDIMAGEFORMAT = \t* $comment: <br />
        <img src="%ATTACHURLPATH%/$name" alt="$name" $size />
 

Email Settings

Line: 82 to 84
 
    • Set HTTP_EQUIV_ON_VIEW =
Changed:
<
<
  • 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">
>
>
  • 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 = 

Revision 232002-01-01 - PeterThoeny

Line: 1 to 1
 

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).
  • ALERT! NOTE: You can lock individual settings at the site or web levels using User & Group Access Control - see section below.
Line: 52 to 52
 
    • HELP 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)
Changed:
<
<
    • Set ATTACHEDIMAGEFORMAT = \t* $comment:
      $name Example image is broken because there is no attached image file.
>
>
    • Set ATTACHEDIMAGEFORMAT = \t* $comment:
      $name
    • HELP NOTE: Example image is broken because there is no attached image file.
 
    • HELP 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

Revision 222001-12-31 - MikeMannix

Line: 1 to 1
Changed:
<
<
TWiki Site-Level 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), and on the user level (create preferences in your user account topic in the Main web, ex: Main.guest).
  • ALERT! NOTE: You can lock individual settings at the site or web levels using User & Group Access Control - see section below.

 
Changed:
<
<
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)
>
>

General Preferences:

 
Changed:
<
<
Preferences:

>
>
 
Changed:
<
<
    • Note: To automatically list all non-hidden webs in alphabetical order you can use this variable instead: Set WIKIWEBLIST = Main  |  TWiki
>
>
    • TIP NOTE: To automatically list all non-hidden webs in alphabetical order, use this variable instead:
      Set WIKIWEBLIST = Main  |  TWiki
 
Changed:
<
<
  • List of topics of a web: (the second line of a topic, is overwritten by web preferences)
>
>
  • List of selected topics in a web - the second line of the upper toolbar (usually overwritten in individual WebPreferences):
 

  • Copyright notice:
Line: 47 to 49
 
  • Format of file link when the link check box is checked: (can be overwritten by user preferences)
    • Set ATTACHEDFILELINKFORMAT = \t* $name: $comment
Changed:
<
<
    • Note: Keyword $name gets expanded to filename; $comment to comment; \t to tab (3 spaces for bullets).
>
>
    • HELP 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)
Changed:
<
<
    • Set ATTACHEDIMAGEFORMAT = \t* $comment:
      $name
    • Note: Above image is shown as broken, it gets expanded correctly when you attach an image.
    • 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).
>
>
    • Set ATTACHEDIMAGEFORMAT = \t* $comment:
      $name Example image is broken because there is no attached image file.
    • HELP 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

 
Changed:
<
<
  • Wiki webmaster email address:
>
>
  • TWiki webmaster email address:
 
Changed:
<
<
  • 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
>
>
  • 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
Changed:
<
<
  • Mail domain sending mail. SMTP requires that you identify the TWiki server sending mail. If not set, Net::SMTP will guess it for you. Examples: twiki.your.company
>
>
  • 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 =
Added:
>
>

Plugins Settings

 
Changed:
<
<
    • Note: In case you have a rough plugin you can disable all plugins with the $disableAllPlugins flag in the TWiki.cfg file.
>
>
    • TIP NOTE: You can enable/disable all plugins with the $disableAllPlugins flag in the lib/TWiki.cfg file.

HTTP-EQUIV Settings

 
Changed:
<
<
  • http-equiv meta tags for view, rdiff, attach, search* scripts:
>
>
  • http-equiv meta tags for view, rdiff, attach, search* scripts:
 
      * Set HTTP_EQUIV_ON_VIEW = 
Changed:
<
<
  • 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">
>
>
  • 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 = 
Changed:
<
<
  • http-equiv meta tags for preview script:
>
>
  • http-equiv meta tags for preview script:
 
      * Set HTTP_EQUIV_ON_PREVIEW = 
Changed:
<
<
  • Users or groups allowed to change or rename this TWikiPreferences topic: (I.e. TWikiAdminGroup)
>
>

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
Added:
>
>

Creating New Preference Variables

 
Changed:
<
<
Notes:
  • A preference is defined as:
    6 spaces * Set NAME = value
    Example:
>
>
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
Changed:
<
<
  • 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).
>
>
  • Preferences are used as TWikiVariables by enclosing the name in percent signs: %. Example:
    • When you write variable %WEBBGCOLOR%, it gets expanded to #FFD8AA .

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

Related Topics

 
Deleted:
<
<
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% .

Revision 212001-12-03 - PeterThoeny

Line: 1 to 1
 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)

Line: 57 to 57
 
Changed:
<
<
  • Mail host for outgoing mail. This is used for WebChangesAlert if Perl module Net::SMTP is installed. If not, sendmail is used instead (defined by $mailProgram in TWiki.cfg). Examples: mail.your.company or localhost
>
>
  • 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
Added:
>
>
  • Mail domain sending mail. SMTP requires that you identify the TWiki server sending mail. If not set, Net::SMTP will guess it for you. Examples: twiki.your.company
    • Set SMTPSENDERHOST =
 
  • 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.
Line: 86 to 89
 
    • Set ALLOWTOPICRENAME =

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

Notes:

Revision 202001-11-20 - PeterThoeny

Line: 1 to 1
 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)

Line: 13 to 13
 

  • Copyright notice:
Changed:
<
<
    • 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.
>
>
    • 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 =

Revision 192001-09-14 - PeterThoeny

Line: 1 to 1
 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)

Line: 57 to 57
 
Changed:
<
<
  • Mail host for outgoing mail. This is used for WebNotification if Perl module Net::SMTP is installed. If not, sendmail is used instead (defined by $mailProgram in TWiki.cfg). Examples: mail.your.company or localhost
>
>
  • Mail host for outgoing mail. This is used for WebChangesAlert if Perl module Net::SMTP is installed. If not, sendmail is used instead (defined by $mailProgram in TWiki.cfg). Examples: mail.your.company or localhost
 
    • Set SMTPMAILHOST = mail

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

Revision 182001-09-09 - PeterThoeny

Line: 1 to 1
 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)

Line: 81 to 81
 
    • Set HTTP_EQUIV_ON_PREVIEW =
Changed:
<
<
  • Users or groups allowed to change this TWikiPreferences topic: (I.e. TWikiAdminGroup)
>
>
  • Users or groups allowed to change or rename this TWikiPreferences topic: (I.e. TWikiAdminGroup)
 
    • Set ALLOWTOPICCHANGE =
Changed:
<
<
  • Users or groups allow to rename this TWikiPreferences topic:
>
>
    • Set ALLOWTOPICRENAME =
 
  • Site-level preferences that are not allowed to be overridden by WebPreferences and user preferences:
    • Set FINALPREFERENCES = PREVIEWBGIMAGE, WIKIWEBMASTER, MAILHOST

Revision 172001-09-01 - MikeMannix

Line: 1 to 1
 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)

Line: 57 to 57
 
Changed:
<
<
  • 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 or localhost
>
>
  • Mail host for outgoing mail. This is used for WebNotification if Perl module Net::SMTP is installed. If not, sendmail is used instead (defined by $mailProgram in TWiki.cfg). Examples: mail.your.company or localhost
 
    • Set SMTPMAILHOST = mail

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

Revision 162001-08-17 - PeterThoeny

Line: 1 to 1
 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)

Line: 45 to 45
 
  • 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 =
Added:
>
>
  • 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:
      $name
    • Note: Above image is shown as broken, it gets expanded correctly when you attach an image.
    • 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).
 

Revision 152001-08-08 - JohnTalintyre

Line: 1 to 1
 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)

Line: 76 to 76
 
    • Set ALLOWTOPICCHANGE =

  • Users or groups allow to rename this TWikiPreferences topic:
Changed:
<
<
>
>
 
  • Site-level preferences that are not allowed to be overridden by WebPreferences and user preferences:
    • Set FINALPREFERENCES = PREVIEWBGIMAGE, WIKIWEBMASTER, MAILHOST

Revision 142001-08-07 - JohnTalintyre

Line: 1 to 1
 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)

Line: 75 to 75
 
  • Users or groups allowed to change this TWikiPreferences topic: (I.e. TWikiAdminGroup)
    • Set ALLOWTOPICCHANGE =
Added:
>
>
  • Users or groups allow to rename this TWikiPreferences topic:
 
  • Site-level preferences that are not allowed to be overridden by WebPreferences and user preferences:
    • Set FINALPREFERENCES = PREVIEWBGIMAGE, WIKIWEBMASTER, MAILHOST

Revision 132001-07-23 - PeterThoeny

Line: 1 to 1
 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)

Line: 6 to 6
 Preferences:

Changed:
<
<
>
>
    • Set WIKIWEBLIST = Main  |  TWiki  |  Know  |  Test
    • Note: To automatically list all non-hidden webs in alphabetical order you can use this variable instead: Set WIKIWEBLIST = Main  |  TWiki
 
  • List of topics of a web: (the second line of a topic, is overwritten by web preferences)
Changed:
<
<
>
>
 
  • Copyright notice:
Changed:
<
<
    • 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.
>
>
    • 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 =

Revision 122001-07-14 - PeterThoeny

Line: 1 to 1
 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)

Line: 61 to 61
 
  • 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 or localhost
    • Set SMTPMAILHOST = mail
Added:
>
>
 
  • http-equiv meta tags for view, rdiff, attach, search* scripts:
      * Set HTTP_EQUIV_ON_VIEW = 
Line: 83 to 89
 
    • Set FINALPREFERENCES = PREVIEWBGIMAGE, WIKIWEBMASTER, MAILHOST
Deleted:
<
<
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)

  • 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

Revision 112001-07-13 - PeterThoeny

Line: 1 to 1
 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)

Line: 45 to 46
 
  • Vertical size of text edit box: (can be overwritten by user preferences)
    • Set EDITBOXHEIGHT = 15
Changed:
<
<
  • Default state of the Release edit lock 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)
>
>
  • 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 =
Added:
>
>
  • 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 =

Revision 102001-06-26 - PeterThoeny

Line: 45 to 45
 
  • Vertical size of text edit box: (can be overwritten by user preferences)
    • Set EDITBOXHEIGHT = 15
Changed:
<
<
  • 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)
>
>
  • Default state of the Release edit lock 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 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 =

Changed:
<
<
  • 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
>
>
  • 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 or localhost
 
    • Set SMTPMAILHOST = mail

  • http-equiv meta tags for view, rdiff, attach, search* scripts:
Added:
>
>
 
    • Set HTTP_EQUIV_ON_VIEW =
Added:
>
>
 
  • 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">
Added:
>
>
 
    • Set HTTP_EQUIV_ON_EDIT =
Added:
>
>
 
  • http-equiv meta tags for preview script:
Added:
>
>
 
    • Set HTTP_EQUIV_ON_PREVIEW =
Added:
>
>
 
  • Users or groups allowed to change this TWikiPreferences topic: (I.e. TWikiAdminGroup)
    • Set ALLOWTOPICCHANGE =

Revision 92001-03-17 - PeterThoeny

Line: 24 to 24
 
  • 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.
Deleted:
<
<
 
  • Exclude web from a web="all" search: (Set to on for hidden webs; is overwritten by web preferences)
    • Set NOSEARCHALL =
Line: 51 to 48
 
  • 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 =
Added:
>
>

  • 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 =
Line: 64 to 67
 
    • Set ALLOWTOPICCHANGE =

  • Site-level preferences that are not allowed to be overridden by WebPreferences and user preferences:
Changed:
<
<
    • Set FINALPREFERENCES = WIKIWEBMASTER, PREVIEWBGIMAGE
>
>
    • Set FINALPREFERENCES = PREVIEWBGIMAGE, WIKIWEBMASTER, MAILHOST
  Plugin Preferences:

Revision 82001-03-14 - PeterThoeny

Line: 66 to 66
 
  • Site-level preferences that are not allowed to be overridden by WebPreferences and user preferences:
    • Set FINALPREFERENCES = WIKIWEBMASTER, PREVIEWBGIMAGE
Added:
>
>
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)

  • 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

Revision 72001-02-22 - PeterThoeny

Line: 54 to 54
 
  • http-equiv meta tags for view, rdiff, attach, search* scripts:
    • Set HTTP_EQUIV_ON_VIEW =
Changed:
<
<
  • 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">
>
>
  • 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:

Revision 62000-12-14 - PeterThoeny

Line: 6 to 6
 
Changed:
<
<
Main | TWiki | Know | Test
>
>
Main | TWiki | Know | Test
  }

  • List of topics of a web: (the second line of a topic, is overwritten by web preferences)
    • Set WEBTOPICLIST = TWiki . {
Changed:
<
<
Home
>
>
Home
  | Changes | Index | Search
Line: 63 to 63
 
  • Users or groups allowed to change this TWikiPreferences topic: (I.e. TWikiAdminGroup)
    • Set ALLOWTOPICCHANGE =
Changed:
<
<
  • Site-level preferences that are not allowed to be overridden by WebPreferences and user preferences:
>
>
  • Site-level preferences that are not allowed to be overridden by WebPreferences and user preferences:
 
    • Set FINALPREFERENCES = WIKIWEBMASTER, PREVIEWBGIMAGE

Notes:

Revision 52000-11-30 - PeterThoeny

Line: 25 to 25
 
    • 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.

  • Wiki webmaster email address:
Changed:
<
<
>
>
 
  • Exclude web from a web="all" search: (Set to on for hidden webs; is overwritten by web preferences)
    • Set NOSEARCHALL =

Revision 42000-10-29 - PeterThoeny

Line: 60 to 60
 
  • http-equiv meta tags for preview script:
    • Set HTTP_EQUIV_ON_PREVIEW =
Added:
>
>
  • 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 = WIKIWEBMASTER, PREVIEWBGIMAGE
  Notes:
  • A preference is defined as:
    6 spaces * Set NAME = value
    Example:
Line: 73 to 78
 
  • 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% .
Added:
>
>

Revision 32000-10-03 - PeterThoeny

Line: 27 to 27
 
Added:
>
>
  • 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
Changed:
<
<
  • Exclude web from a web="all" search: (Set to on for hidden webs; is overwritten by web preferences)
    • Set NOSEARCHALL =
>
>
  • PreviewBackground image:
    • Set PREVIEWBGIMAGE = /twiki_cstc/pub/TWiki/PreviewBackground/previewbg.gif
 
  • Background color of non existing topic: ( default cornsilk or #FFFFCE )
    • Set NEWTOPICBGCOLOR = #FFFFCE

Revision 22000-09-20 - PeterThoeny

Line: 33 to 33
 
  • Exclude web from a web="all" search: (Set to on for hidden webs; is overwritten by web preferences)
    • Set NOSEARCHALL =
Added:
>
>
  • 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

Revision 12000-08-16 - PeterThoeny

Line: 1 to 1
Added:
>
>
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 topics of a web: (the second line of a topic, is overwritten by web preferences)

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

  • Web specific background color: (is overwritten by web preferences)
    • Set WEBBGCOLOR = #C0C0C0

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

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

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

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% .
 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 1999-2024 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.