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 %WIKITOOLNAME% 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 %WIKITOOLNAME% maintenance.
---+++ 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
* TWiki webmaster email address:
* Set WIKIWEBMASTER = webmaster@strategoxt.org
* TWiki webmaster name (first name and last name, e.g. =Fred Smith=):
* Set WIKIWEBMASTERNAME = Eelco Visser
* 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 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
* Set MAILTHISTOPIC = [[mailto:?subject=%BASETOPIC%&body=%TOPICURL% %MAILTHISTOPICTEXT%]]
* 'Mail this topic' link text
* Set MAILTHISTOPICTEXT = Send a link to this page
* URL for current topic
* Set TOPICURL = %SCRIPTURL%/view%SCRIPTSUFFIX%/%WEB%/%BASETOPIC%
---+++ HTTP-EQUIV Settings
* %T% *NOTE:* Changing cache behaviour with these settings should not be necessary and may cause cache-related problems (e.g. TWiki:Codev/BackFromPreviewLosesText or TWiki:Codev/RefreshEditPage). These settings do not affect proxy caches.
* ==http-equiv== meta tags for ==view==, ==rdiff==, ==attach==, ==search*== scripts:
* #Set HTTP_EQUIV_ON_VIEW =
* Set HTTP_EQUIV_ON_VIEW =
* ==http-equiv== meta tags for ==edit== script:
* Set HTTP_EQUIV_ON_EDIT =
* ==http-equiv== meta tags for ==preview== script:
* Set HTTP_EQUIV_ON_PREVIEW =
---++ Skin Settings
* Skin overriding the default TWiki templates: (can be overwritten by WebPreferences and user preferences)
* Set SKIN = flexpattern
* __Note:__ See TWikiSkinBrowser for currently installed skins
---+++ PatternSkin
* Using attachments for styles
* Set TWIKILAYOUTURL = %PUBURL%/%TWIKIWEB%/PatternSkin/layout.css
* Set TWIKISTYLEURL = %PUBURL%/%TWIKIWEB%/PatternSkin/style.css
---+++ DragonSkin
* Theme: (gray, monochrome, tabstyle)
* Set DS_THEME = gray
* Quicklinks headings:
* Set DS_QUICKLINKSHEADING =
* Quicklinks submenu:
* Set DS_QUICKLINKS =
---++ 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 %TWIKIWEB% web for the plugin topics. Specify plugins as a comma separated list of topics.
* Set INSTALLEDPLUGINS = TWiki.DefaultPlugin, SpreadSheetPlugin
* Set DISABLEDPLUGINS = EmptyPlugin
* Currently activated plugins: %ACTIVATEDPLUGINS%
* %T% *NOTE:* You can enable/disable all plugins with the ==$disableAllPlugins== flag in the ==lib/TWiki.cfg== file.
---++ Miscellaneous Settings
* Line break:
* Set BR =
* Bullet sign:
* Set BULLET = •
* Line break and bullet with different levels of indentation:
* Set BB = •
* Set BB2 = •
* Set BB3 = •
* Set BB4 = •
* Colored text: (see more StandardColors)
| You type: | =%RED% red text %ENDCOLOR% and %GREEN% green text %ENDCOLOR%= |
| You get: | %RED% red text %ENDCOLOR% and %GREEN% green 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%=, e.g. write =%RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%=.
* %YELLOW% *Set YELLOW = looks like this* %ENDCOLOR%
* %ORANGE% *Set ORANGE = looks like this* %ENDCOLOR%
* %RED% *Set RED = looks like this* %ENDCOLOR%
* %PINK% *Set PINK = looks like this* %ENDCOLOR%
* %PURPLE% *Set PURPLE = looks like this* %ENDCOLOR%
* %TEAL% *Set TEAL = looks like this* %ENDCOLOR%
* %NAVY% *Set NAVY = looks like this* %ENDCOLOR%
* %BLUE% *Set BLUE = looks like this* %ENDCOLOR%
* %AQUA% *Set AQUA = looks like this* %ENDCOLOR%
* %LIME% *Set LIME = looks like this* %ENDCOLOR%
* %GREEN% *Set GREEN = looks like this* %ENDCOLOR%
* %OLIVE% *Set OLIVE = looks like this* %ENDCOLOR%
* %MAROON% *Set MAROON = looks like this* %ENDCOLOR%
* %BROWN% *Set BROWN = looks like this* %ENDCOLOR%
* %BLACK% *Set BLACK = looks like this* %ENDCOLOR%
* %GRAY% *Set GRAY = looks like this* %ENDCOLOR%
* %SILVER% *Set SILVER = looks like this* %ENDCOLOR%
* %WHITE% *Set WHITE = looks like this (with gray background)* %ENDCOLOR%
* The following color settings are enclosed in verbatim tags to avoid incorrect nesting of XHTML tags:
* 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 =
#DocGraphics
* Graphics used in TWiki documentation - view all images in %TWIKIWEB%.TWikiDocGraphics. _(There are various ways to set up common icons as text variables. This is simply one quick approach.)_:
* Set H =
* Set I =
* Set M =
* Set N =
* Set P =
* Set Q =
* Set S =
* Set T =
* Set U =
* Set X =
* Set Y =
* Background color of non existing topic: ( default =cornsilk= or =#FFFFCE= )
* Set NEWTOPICBGCOLOR = #FFFFCE
* Font color of non existing topic: ( default =#0000FF= )
* Set NEWTOPICFONTCOLOR = #0000FF
* %TWIKIWEB%.PreviewBackground image:
* Set PREVIEWBGIMAGE = %PUBURLPATH%/%TWIKIWEB%/PreviewBackground/preview2bg.gif
---++ Access Control Settings
* Users or groups allowed to change or rename this %TOPIC% topic: (ex: %MAINWEB%.TWikiAdminGroup)
* Set ALLOWTOPICCHANGE = %MAINWEB%.TWikiAdminGroup
* Set ALLOWTOPICRENAME = %MAINWEB%.TWikiAdminGroup
* Users or groups allowed to [[%TWIKIWEB%.ManagingWebs][create new webs]]: (ex: %MAINWEB%.TWikiAdminGroup)
* Set ALLOWWEBMANAGE = %MAINWEB%.WebManageGroup
---++ 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 %WEBPREFSTOPIC% and user preferences:
* Set FINALPREFERENCES = ATTACHFILESIZELIMIT, PREVIEWBGIMAGE, WIKITOOLNAME, WIKIWEBMASTER, SMTPMAILHOST, SMTPSENDERHOST, ALLOWWEBMANAGE, READTOPICPREFS, TOPICOVERRIDESUSER, ALLOWTOPICCHANGE, ALLOWTOPICRENAME, ALLOWWEBMANAGE
---++ Creating New Preference Variables
You can introduce new VARIABLES and use them in your topics and templates. There is no need to change the TWiki engine (Perl scripts).
* A preference is defined in a TWikiShorthand bullet item: ==[3 spaces] * [space] Set NAME = value== Example (as a nested bullet item, indented 6 spaces):
* Set WEBBGCOLOR = #FFFFC0
* Preferences are used as %TWIKIWEB%.TWikiVariables by enclosing the name in percent signs: ==%==. Example:
* When you write variable ==%WEBBGCOLOR%==, it gets expanded to =%WEBBGCOLOR%= .
* %X% 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
* %WEBPREFSTOPIC% has preferences of the %WIKITOOLNAME%.%WEB% web.
* %MAINWEB%.%WIKIUSERSTOPIC% has a list of user topics. User topics can have optional user preferences.
* %TWIKIWEB%.TWikiVariables has a list of common =%VARIABLES%=.
* %TWIKIWEB%.TWikiAccessControl explains how to restrict access by users or groups.
__Note__: Can't edit?
[[%SCRIPTURL%/view%SCRIPTSUFFIX%/%WEB%/%TOPIC%?raw=on][View raw topic]]