Difference: TWikiPreferences (85 vs. 86)

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-2018 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-2018 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 2018 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 = /pub/TWiki/PatternSkin/layout.css
    • Set TWIKISTYLEURL = /pub/TWiki/PatternSkin/style.css
    • Set TWIKICOLORSURL = /pub/TWiki/PatternSkin/colors.css
Line: 198 to 213
 
    • Set WEBHEADERART = /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 = /bin/edit/TWiki/TWikiPreferences?t=1532117249
    • 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

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