| |
-
- #Set LINKTOOLTIPINFO = $username - $date - $rev: $summary
- Horizontal size of text edit box: (can be overwritten by user preferences)
- Vertical size of text edit box: (can be overwritten by user preferences)
- Style of text edit box. Set to
width: 99% for full window width (default; this will overwrite the EDITBOXWIDTH setting), or width: auto to disable. This setting works for IE and some other recent browsers. (can be overwritten by user preferences)
- Set EDITBOXSTYLE = width: 99%
- Default state of the Release edit lock (UnlockTopic) check box in preview. Checkbox is initially checked if
Set RELEASEEDITLOCKCHECKBOX = checked="checked", or unchecked if empty. If checked, make sure to click on Edit to do more changes; do not go back in your browser to the edit page, or you risk that someone else will edit the topic at the same time: (can be overwritten by user preferences)
- Set RELEASEEDITLOCKCHECKBOX =
- Default state of the Minor Changes, Don't Notify (DontNotify) check box in preview. Check box is initially checked if
Set DONTNOTIFYCHECKBOX = checked="checked", or unchecked if empty: (can be overwritten by user preferences)
- 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)
- Format of file link when the link check box is checked: (can be overwritten by user preferences)
-
 NOTE: Keyword $name gets expanded to filename; $comment to comment; \t to tab (3 spaces for bullets).
- Set ATTACHEDFILELINKFORMAT = \t* $name: $comment
- Format of images when the link check box is checked: (can be overwritten by user preferences)
- NOTE: Keyword
$name gets expanded to filename; $comment to comment; $size to width="..." height="..." attribute of img tag; \t to tab (3 spaces for bullets).
* Set ATTACHEDIMAGEFORMAT = \t* $comment: <br />
<img src="%ATTACHURLPATH%/$name" alt="$comment" $size />
TWiki Platform Settings
- TWiki site 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 | Sandbox
-
 NOTE: To automatically list all non-hidden webs in alphabetical order, use the %WEBLIST{}% variable instead:
TWiki
- Maximum size of FileAttachments in KB, 0 for no limit:
- Set ATTACHFILESIZELIMIT = 10000
- Broadcast message for skins supporting a %BROADCASTMESSAGE% at the top of the page: (IMPORTANT: Set to empty message if not used; #Comment out unused messages)
- Set BROADCASTMESSAGE =
- #Set BROADCASTMESSAGE =
| NOTE: Edit and Attach will be disabled today between 05:00 PM and 06:00 PM PDT (00:00 to 01:00 GMT) for a scheduled TWiki maintenance. |
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:
- TWiki webmaster name (first name and last name, e.g.
Fred Smith):
- 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
- 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
- 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
- 'Mail this topic' link text
- Set MAILTHISTOPICTEXT = Send a link to this page
HTTP-EQUIV Settings
-
http-equiv meta tags for view, rdiff, attach, search* scripts:
* #Set HTTP_EQUIV_ON_VIEW =
* Set HTTP_EQUIV_ON_VIEW = <link rel="alternate" type="application/rss+xml" title="RSS Feed" href="%SCRIPTURL%/view%SCRIPTSUFFIX%/%WEB%/WebRss?skin=rss&contenttype=text/xml" />
-
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)
- Using attachments for styles
- 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
- Theme: (gray, monochrome, tabstyle)
- Quicklinks headings:
- Set DS_QUICKLINKSHEADING =
- Quicklinks submenu:
Plugins Settings
- TWikiPlugins configuration: All plugin modules that exist in the
lib/TWiki/Plugins directory are activated automatically unless disabled by DISABLEDPLUGINS. You can optionally list the installed plugins in INSTALLEDPLUGINS. This is useful to define the sequence of plugin execution, or to specify other webs then the TWiki web for the plugin topics. Specify plugins as a comma separated list of topics.
- Set INSTALLEDPLUGINS = DefaultPlugin, SpreadSheetPlugin
- Set DISABLEDPLUGINS = EmptyPlugin
- Currently activated plugins: SpreadSheetPlugin, BackupRestorePlugin, ColorPickerPlugin, CommentPlugin, DBIQueryPlugin, DatePickerPlugin, EditTablePlugin, HeadlinesPlugin, InterwikiPlugin, JQueryPlugin, PreferencesPlugin, SetGetPlugin, SlideShowPlugin, SmiliesPlugin, TWikiSheetPlugin, TablePlugin, TagMePlugin, TinyMCEPlugin, TwistyPlugin, WatchlistPlugin, WysiwygPlugin
- NOTE: You can enable/disable all plugins with the
$disableAllPlugins flag in the lib/TWiki.cfg file.
Miscellaneous Settings
- Line break and bullet with different levels of indentation:
- Set BB =
•
- Set BB2 =
•
- Set BB3 =
•
- Set BB4 =
•
- Colored text: (see more StandardColors)
| You type: | %RED% red text %ENDCOLOR% and %GREEN% green text %ENDCOLOR% | | You get: | red text and green text |
* Set YELLOW = <font color="#ffff00">
* Set ORANGE = <font color="#ff6600">
* Set RED = <font color="#ff0000">
* Set PINK = <font color="#ff00ff">
* Set PURPLE = <font color="#800080">
* Set TEAL = <font color="#008080">
* Set NAVY = <font color="#000080">
* Set BLUE = <font color="#0000ff">
* Set AQUA = <font color="#00ffff">
* Set LIME = <font color="#00ff00">
* Set GREEN = <font color="#008000">
* Set OLIVE = <font color="#808000">
* Set MAROON = <font color="#800000">
* Set BROWN = <font color="#996633">
* Set BLACK = <font color="#000000">
* Set GRAY = <font color="#808080">
* Set SILVER = <font color="#c0c0c0">
* Set WHITE = <font color="#ffffff">
* Set ENDCOLOR = </font>
- 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 =
- 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
- PreviewBackground image:
- Set PREVIEWBGIMAGE = /twiki/pub/TWiki/PreviewBackground/preview2bg.gif
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.
- 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, BASICSTYLETOPIC
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):
- 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. For example, set WEBCOPYRIGHT before WIKIWEBMASTER since the copyright notice uses the webmaster email address.
Related Topics
Note: Can't edit?
View raw topic |
Copyright © 1999-2025 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.