Difference: TWikiPreferences (81 vs. 82)

Revision 822010-05-26 - 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.

Changed:
<
<
ALERT! Note: This topic should be regarded as read-only, so that upgrades can safely overwrite it without risk to your customizations.
>
>
ALERT! NOTE: Don't edit this topic, changes will be lost on the next TWiki upgrade. Define new site-level settings, or overload below settings in Main.TWikiPreferences
  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.
Line: 33 to 33
 
  • 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
Changed:
<
<
    • Set SITEMAPWHAT = Describe what this web does.
    • Set SITEMAPUSETO = ...to do something.
>
>
    • Set SITEMAPWHAT = Describe what this web does
 
  • Copyright notice:
    • 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
Line: 119 to 118
 
  • 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:
<
<
>
>
 
  • Home page of this site
    • Set WIKIHOMEURL = /bin/view
Line: 157 to 156
 
  • 'Mail this topic' link text
    • Set MAILTHISTOPICTEXT = Send a link to this page
Deleted:
<
<
 

HTTP-EQUIV Settings

Line: 180 to 174
 

Skin Settings

  • Skin overriding the default TWiki templates: (can be overwritten by WebPreferences and user preferences)
Changed:
<
<
    • Set SKIN = pattern
>
>
    • Set SKIN = tagme, topmenu, pattern
 
Line: 200 to 194
 
    • Set WEBHEADERART = /pub/TWiki/PatternSkin/TWiki_header.gif
    • #Set WEBHEADERBGCOLOR = #faf8f0

Changed:
<
<

Skin icons

>
>

Skin Icons

 
  • Topic containing the icon graphics library. Icons can easily be rendered with %ICON{name}%.
Changed:
<
<
>
>

Legacy Support

 
Deleted:
<
<

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=1574351220
    • Set EDITTOPIC = Edit
Line: 226 to 221
 

Rendering Shortcuts Settings

Added:
>
>
  • Line break and bullet with different levels of indentation:
    • Set BB =
    • Set BB2 =
        •
    • Set BB3 =
          •
    • Set BB4 =
            •
 
  • Line break: Note that the setting has an intentional trailing space
    • Set BR =

  • Bullet sign:
    • Set BULLET = •
Deleted:
<
<
  • Vertical bar / pipe symbol:
    • Set VBAR = |
 
  • Vertical caret symbol:
    • Set CARET = ^
Changed:
<
<
  • Line break and bullet with different levels of indentation:
    • Set BB =
    • Set BB2 =
        •
    • Set BB3 =
          •
    • Set BB4 =
            •
>
>

  • Vertical bar / pipe symbol:
    • Set VBAR = |
 
  • Hint: Above shortcuts are useful in TWiki tables where you cannot use newlines
Line: 263 to 261
 
  • Colored text: (see more StandardColors)
    You type: %RED% red text %ENDCOLOR% and %GREEN% green text %ENDCOLOR%
    You get: red text and green text
Changed:
<
<
    • 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%.
>
>
    • 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%, such as %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%.
 
<-- Two sets of colors follow: Color test and color setting -->
Changed:
<
<
    • Set YELLOW = looks like this
    • Set ORANGE = looks like this
    • Set RED = looks like this
    • Set PINK = looks like this
    • Set PURPLE = looks like this
    • Set TEAL = looks like this
    • Set NAVY = looks like this
    • Set BLUE = looks like this
    • Set AQUA = looks like this
    • Set LIME = looks like this
    • Set GREEN = looks like this
    • Set OLIVE = looks like this
    • Set MAROON = looks like this
    • Set BROWN = looks like this
    • Set BLACK = looks like this
    • Set GRAY = looks like this
    • Set SILVER = looks like this
    • Set WHITE = looks like this (with gray background)
    • The following color settings are enclosed in verbatim tags to avoid incorrect nesting of XHTML tags:
>
>
    • %YELLOW% looks like this
    • %ORANGE% looks like this
    • %RED% looks like this
    • %PINK% looks like this
    • %PURPLE% looks like this
    • %TEAL% looks like this
    • %NAVY% looks like this
    • %BLUE% looks like this
    • %AQUA% looks like this
    • %LIME% looks like this
    • %GREEN% looks like this
    • %OLIVE% looks like this
    • %MAROON% looks like this
    • %BROWN% looks like this
    • %BLACK% looks like this
    • %GRAY% looks like this
    • %SILVER% looks like this
    • %WHITE% looks like this (with gray background)
    • The following settings define the colors: (they are enclosed in verbatim tags to avoid incorrect nesting of XHTML tags)
 
Changed:
<
<
    • 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 =
>
>
    • 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 =

  • Colored background: (see more StandardColors)        
    You type: %REDBG% red background %ENDBG% %GREENBG% green background %ENDBG%
    You get:
    red background
    green background
    • Note: These background colors are block level elements, e.g. take up a whole row of text by default. Useful to set background colors in cells of TWiki tables.
      <-- Two sets of colors follow: Color test and color setting -->
    • %YELLOWBG% looks like this
    • %ORANGEBG% looks like this
    • %REDBG% looks like this
    • %PINKBG% looks like this
    • %PURPLEBG% looks like this
    • %TEALBG% looks like this
    • %NAVYBG% looks like this
    • %BLUEBG% looks like this
    • %AQUABG% looks like this
    • %LIMEBG% looks like this
    • %GREENBG% looks like this
    • %OLIVEBG% looks like this
    • %MAROONBG% looks like this
    • %BROWNBG% looks like this
    • %BLACKBG% looks like this
    • %GRAYBG% looks like this
    • %SILVERBG% looks like this
    • %WHITEBG% looks like this
    • The following settings define the background colors: (they are enclosed in verbatim tags to avoid incorrect nesting of XHTML tags)
      * Set YELLOWBG = <div style="background-color: #ffff80; padding:0 3px 0 3px">
      * Set ORANGEBG = <div style="background-color: #ffbb80; padding:0 3px 0 3px">
      * Set REDBG = <div style="background-color: #ff8080; padding:0 3px 0 3px">
      * Set PINKBG = <div style="background-color: #ff80ff; padding:0 3px 0 3px">
      * Set PURPLEBG = <div style="background-color: #dd99dd; padding:0 3px 0 3px">
      * Set TEALBG = <div style="background-color: #80c0c0; padding:0 3px 0 3px">
      * Set NAVYBG = <div style="background-color: #8080c0; padding:0 3px 0 3px">
      * Set BLUEBG = <div style="background-color: #8080ff; padding:0 3px 0 3px">
      * Set AQUABG = <div style="background-color: #80ffff; padding:0 3px 0 3px">
      * Set LIMEBG = <div style="background-color: #80ff80; padding:0 3px 0 3px">
      * Set GREENBG = <div style="background-color: #99cc99; padding:0 3px 0 3px">
      * Set OLIVEBG = <div style="background-color: #c0c080; padding:0 3px 0 3px">
      * Set MAROONBG = <div style="background-color: #c08080; padding:0 3px 0 3px">
      * Set BROWNBG = <div style="background-color: #bb9988; padding:0 3px 0 3px">
      * Set BLACKBG = <div style="background-color: #000000; padding:0 3px 0 3px">
      * Set GRAYBG = <div style="background-color: #a0a0a0; padding:0 3px 0 3px">
      * Set SILVERBG = <div style="background-color: #c0c0c0; padding:0 3px 0 3px">
      * Set WHITEBG = <div style="background-color: #ffffff; padding:0 3px 0 3px">
      * Set ENDBG = </div>
 

Miscellaneous Settings

Line: 324 to 369
 
  • User-friendly synonyms for system webs
    • Set DOCWEB = TWiki

Changed:
<
<
>
>
 
    • Set ADMINLOGIN = internal admin login (use the username suggested and the password set in configure).
Changed:
<
<

Access Control Settings

>
>

Security Settings

 
Changed:
<
<
  • No-one (except admins) should change this topic
>
>
  • Only TWiki administrators are allowed to change this topic:
 
Added:
>
>
  • Disable WYSIWYG editor for this preferences topic only:
    • Local TINYMCEPLUGIN_DISABLE = on
 

Creating New Preference Variables

Line: 359 to 406
 
  • 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.
Changed:
<
<
>
>
  Note: Can't edit? View raw topic
Added:
>
>
ALERT! NOTE: Don't edit this topic, changes will be lost on the next TWiki upgrade. Define new site-level settings, or overload above settings in Main.TWikiPreferences
 
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.