Difference: TWikiPreferences (77 vs. 78)

Revision 782007-04-14 - Main.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 2019 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 = /wiki/bin/view
Changed:
<
<
>
>
 
    • TIP NOTE: To automatically list all non-hidden webs in alphabetical order, use the %WEBLIST{}% variable instead:
      Lean | Main | Sandbox | 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 = /wiki/pub/TWiki/PatternSkin/layout.css
    • Set TWIKISTYLEURL = /wiki/pub/TWiki/PatternSkin/style.css
    • Set TWIKICOLORSURL = /wiki/pub/TWiki/PatternSkin/colors.css
>
>
    • Set TWIKILAYOUTURL = /wiki/pub/TWiki/PatternSkin/layout.css
    • Set TWIKISTYLEURL = /wiki/pub/TWiki/PatternSkin/style.css
    • Set TWIKICOLORSURL = /wiki/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 = /wiki/pub/TWiki/PatternSkin/TWiki_header.gif
    • Set WEBHEADERBGCOLOR = #ffffff
>
>
    • Set WEBHEADERART = /wiki/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 = /wiki/pub/TWiki/PreviewBackground/preview2bg.gif
>
>
  • PreviewBackground image:
    • Set PREVIEWBGIMAGE = /wiki/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?

 
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