SitePreferences

help Foswiki's default preferences are located in System.DefaultPreferences, however settings defined here have override priority and should be used for local customisations.

Site Settings

  • Set MAINWEB = Main
  • Set SHAREDWEB = Main/Shared
  • Set TWIKIWEB = System

  • Set WEBSUMMARY =

Defined in configure
  • USERSWEB = Main
  • SYSTEMWEB = System
  • TRASHWEB = Trash
Customize logo and tooltip texts:


   * [[http://en.wikipedia.org/wiki/Favicon][favicon]]: Attach a =favicon.ico= to a web's WebPreferences or add a =FAVICON= setting to WebPreferences
      * Set FAVICON = %PUBURLPATH%/%SYSTEMWEB%/ProjectLogos/favicon.ico

   * Image, URL and alternate tooltip text of web's logo.
      * Set WIKILOGOIMG = %PUBURL%/%SYSTEMWEB%/ProjectLogos/foswiki-logo.png
      * Set WIKILOGOALT = by Foswiki
      * Set WIKILOGOURL = %SCRIPTURL{"view"}%/%USERSWEB%/%HOMETOPIC%
      * Set WEBLOGOIMG = %WIKILOGOIMG%
      * Set WEBLOGOURL = %WIKILOGOURL%
      * Set WEBLOGOALT = %WIKILOGOALT%
      * Set WEBTAGLINE = %BASEWEB%

   * Site name
      * Set WIKITOOLNAME = CFCL Wiki

   * Home page of this site
      * Set WIKIHOMEURL = %SCRIPTURLPATH{"view"}%/

<sticky>
   * Copyright notice:
      * #Set WEBCOPYRIGHT = <span class="foswikiRight"> <a href="http://foswiki.org/"><img src="%PUBURLPATH%/%SYSTEMWEB%/ProjectLogos/foswiki-badge.png" alt="%MAKETEXT{"This site is powered by Foswiki"}%" title="%MAKETEXT{"This site is powered by Foswiki"}%" /></a></span>%MAKETEXT{"Copyright &&copy; by the contributing authors. All material on this collaboration platform is the property of the contributing authors." args="1999-%GMTIME{$year}%"}% <br /> %MAKETEXT{"Ideas, requests, problems regarding [_1]? <a href='[_2]'>Send feedback</a>" args="<nop>%WIKITOOLNAME%,mailto:%WIKIWEBMASTER%?subject=%WIKITOOLNAME%%20Feedback%20on%20%BASEWEB%.%BASETOPIC%"}%

   * Simplified Copyright notice for the WebRss feed (don't use any special characters, html tags, entities, wiki markup or WikiWords)
      * #Set WEBRSSCOPYRIGHT = Copyright %GMTIME{"$year"}% by contributing authors
</sticky>

Customize your favicon:
  • Set FAVICON = /pub/System/ProjectLogos/favicon.ico

Customize your top bar background image and color
   * Set WEBHEADERART = %PUBURLPATH%/%SYSTEMWEB%/PatternSkin/header5.gif
   * Set WEBHEADERBGCOLOR = #ffffff

   * Set AUTHUSER = %IF{"context authenticated" then="true" else=""}%

  • Prevent automatic linking of WikiWords and acronyms (if set to on); link WikiWords (if empty); can be overwritten by web preferences:
    • Set NOAUTOLINK = on

    • 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.
  • 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 = on

  • Maximum size of System.FileAttachments in KB, 0 for no limit:
    • Set ATTACHFILESIZELIMIT = 50000

Styles

  • Default TWiki styles (PatternSkin)
    • # TWIKILAYOUTURL = /pub/System/PatternSkin/layout.css
    • # TWIKISTYLEURL = /pub/System/PatternSkin/style.css
    • # TWIKICOLORSURL = /pub/System/PatternSkin/colors.css

  • Custom overriding styles (enabled pr. default but empty, to prevent browsers from fetching %USERLAYOUTURL%-style URLs)
    • #Set USERLAYOUTURL =
    • #Set USERSTYLEURL = /pub/System/PatternSkinCssCookbookNoLeftBar/hideleftbar.css
    • #Set USERCOLORSURL =

Plugin Configuration

  • Set TABLEPLUGIN_TABLEATTRIBUTES = tableborder="3" cellpadding="10" valign="top" tablerules="all" headerrules="all" databg="#fff,#f6f8ff" headerbg="#afd5f3"

  • Set INTERWIKIPLUGIN_RULESTOPIC = System.InterWikis, Main/Shared.InterWikis
  • Set TWISTYPLUGIN_TWISTYMODE = div

Colors and Graphics

  • Colored text: (see more TWiki.StandardColors)
    You type: %RED% red text %ENDCOLOR% and %GREEN% green text %ENDCOLOR%
    You get: red text and green text
    • 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%.
    • 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 CYAN = 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:
      * 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 CYAN = <font color="#3399ff">
      * 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 System.DocumentGraphics. (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
    • Set TWikiLogo = TWiki
    • Set FoswikiLogo = TWiki
    • Set BAAPT_icon = BAAPT
    • Set LinkedIn_icon = LinkedIn_icon.png
    • Set Twitter_icon = Twitter_icon.png
    • Set Meetup_icon = Meetup_icon.jpg
    • Set Facebook_icon = Facebook_icon.png
    • Set Google_icon = Google_icon.png
    • Set Pinterest_icon = Pinterest_icon.png
    • Set UNDER_CONSTRUCTION = Under construction

E-mail Settings

  • TWiki administrator e-mail address:

  • TWiki administrator name (first name and last name, e.g. Fred Smith):
    • Set WIKIWEBMASTERNAME = Wiki Admin

  • '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

Other

  • I really don't care if it's not Wiki Words
    • Set HIDE_NON_WIKI_WORD_WARNINGS = 1

Local Variables

Assorted convenience settings for CFCL webs...

Look & Feel

   * Set NoLeftBar = <link rel="stylesheet" type="text/css" href="%PUBURLPATH%/Help/HideWebLeftBar/noleftbar.css" />
      * Use =%<nop>NoLeftBar%= to hide the left bar on a page

   * Set BlockNone = %IF{"context authenticated" then='style="display: block;"' else='style="display: none;"'}%
      * Use: <div %BlockNone%>... </div>

   * Set AdminOnly = %IF{"context isadmin" then='style="display: block;"' else='style="display: none;"'}%
      * Use: <div %AdminOnly%>... </div>

Editing

  • Style of text edit box. width: 99% for full window width (default), width: auto to disable.
    • #Set EDITBOXSTYLE = width: 95%; font-family: monospace; font-size: 110%; font-weight: 600;

Our names, for signatures

  • Set Vicki = Vicki
  • Set Rich = Rich

Special Variables

  • Set RENDERLISTPLUGIN_CHECKBOX_THEME = icon, 1, 16, 16, empty.gif, empty.gif, empty.gif, empty.gif, checked.png

Highlight a section of text

   * Set HILITE = <span style="background-color: #FFFF66;">
   * Set HILITE_YELLOW = <span style="background-color: #FFFF66;">
   * Set HILITE_GREEN = <span style="background-color: #6F6;">
   * Set HILITE_BLUE = <span style="background-color: #00FFFF;">
   * Set HILITE_PINK = <span style="background-color: #FFCCFF;">
   * Set HILITE_PURPLE = <span style="background-color: #EEDDFF;">
   * Set ENDHI = </span>
  • example: highlighted text

Underline

   * Set UNDER = <span style="text-decoration: underline;">
   * Set ENDSPAN = </span>
  • example: underlined text

Cursive

   * Set CURSIVE = <span style="font-family: cursive;">
   * Set ENDSPAN = </span>
* example: Cursive text

Indent a section of text

      * Set INDENT = <div style="margin-left: 40px;">
      * Set ENDENT = </div>
  • example
this text is indented

Fast Twisties

   * Set FLIP = %TWISTY{showlink=" " hidelink=" " showimgright="%ICONURLPATH{toggleopen-small}%" hideimgright="%ICONURLPATH{toggleclose-small}%" }%
   * Set FLOP = %ENDTWISTY%

Deprecate a section of text

   * Set DEPRECATE = <div style="background-image: url('%PUBURLPATH%/MediaOps/TWikiTutCSS/deprecated.gif');"> %GRAY%
   * Set ENDDEP = %ENDCOLOR% </div>

  • example:


This text has been deprecated


   * Blog variables are set in [[Blog.WebPreferences]]

   * Set ERss  = %STARTSECTION{name="export" type="section"}%
   * Set ERes  = %ENDSECTION{name="export" type="section"}%

   * Set TCb   = %INCLUDE{"Projects/WebIncludes" section="tc_beg"}%
   * Set TCe   = %INCLUDE{"Projects/WebIncludes" section="tc_end"}%

   * Set ZB    = %INCLUDE{"Projects/WebIncludes" section="zb" web="%INCLUDINGWEB%" topic="%INCLUDINGTOPIC%"}%


Plugin Settings

Interwiki

  • Set INTERWIKIPLUGIN_RULESTOPIC = System.InterWikis, Main.InterWikis

Table

  • Set TABLEATTRIBUTES = tableborder="1" sort="off" headercolor="#000" headerbg="#ffffe6" databg="#FFFFFF, #FFFFFF"
  • Note bug in (Dakar, 8154) version of TablePlugin: headerbg setting in TABLEATTRIBUTES only has an effect if %TABLE macro is specified.
A B C
apple banana cherry
aardvark bat cat

Finalisation

FINALPREFERENCES locks site-level preferences that are not allowed to be overridden by WebPreferences or user preferences:

  • Set FINALPREFERENCES = ATTACHFILESIZELIMIT, PREVIEWBGIMAGE, WIKITOOLNAME, WIKIHOMEURL, ALLOWROOTCHANGE, DENYROOTCHANGE, USERSWEB, SYSTEMWEB, DOCWEB
Topic revision: r45 - 29 Aug 2016, VickiBrown
This site is powered by FoswikiCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding CFCL Wiki? Send feedback