Difference: TWikiPreferences (73 vs. 74)

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-2019 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 2019 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 = /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  |  SPhenix  |  TWiki
>
>
Main | SPhenix | 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 = /pub/TWiki/PatternSkin/layout.css
    • Set TWIKISTYLEURL = /pub/TWiki/PatternSkin/style.css
    • Set TWIKICOLORSURL = /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 = /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 = /bin/edit/TWiki/TWikiPreferences?t=1569112891
    • 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 = /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
 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 1999-2019 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.