Skip to topic | Skip to bottom
Home
You are here: APS Sahaja Yoga > TWiki Web > TWikiPreferences r10 - 11 Mar 2006 - 10:32 - RoccoVR


Start of topic | Skip to actions

APS Sahaja Yoga Site-Level Preferences

This topic defines site-level settings that apply to all users and webs on this TWikiSite. This topic should be regarded as read-only, so that upgrades can safely overwrite it without risk to your customaisations.

Preference settings local to your site should be set in TWikiPreferences (this topic is pointed to by {LocalSitePreferences}, which is set by the admin in the configure interface). Settings in TWikiPreferences will override settings in this topic, and should be used for defining custom settings and variables.

See here for more information on how to set Preferences Variables.

(Click for form-based editing of existing preferences.)

Default Web Preferences

warning NOTE: They are typically redefined in individual WebPreferences topics

  • List of selected topics in a web - the second line of the upper toolbar (usually overwritten in individual WebPreferences):

  • Web-specific background color: (is overwritten by web preferences)
    • Set WEBBGCOLOR = #FF3366

  • Image, URL and alternate tooltip text of web's logo. Note: don't add your own local logos to the TWikiLogos topic; create your own logos topic instead.

  • Simplified Copyright notice for the WebRss feed (don't use any special characters, xml tags or WikiWords)
    • Set WEBRSSCOPYRIGHT = Copyright 2005 by contributing authors

  • Exclude web from a web="all" search: (Set to on for hidden webs; is overwritten by web preferences)
    • Set NOSEARCHALL = off

  • Prevent automatic linking of WikiWords and acronyms (if set to on); link WikiWords (if empty); can be overwritten by web preferences:
    • Set NOAUTOLINK = off
    • 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.

  • 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

warning NOTE: They are typically redefined in topics of individual TWikiUsers

  • 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: (can be overwritten by user preferences)
    • Set EDITBOXWIDTH = 70

  • Vertical size of text edit box: (can be overwritten by user preferences)
    • Set EDITBOXHEIGHT = 15

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

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

  • Default state of the link check box in the attach file page. Checkbox is initially checked if Set ATTACHLINKBOX = checked="checked", or unchecked if empty (Set ATTACHLINKBOX =). If checked, a link is created to the attached file at the end of the topic: (can be overwritten by user preferences)
    • Set ATTACHLINKBOX =

  • 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).
    • Set ATTACHEDFILELINKFORMAT = \t* $name: $comment

  • Format of images when the link check box is checked: (can be overwritten by user preferences)
    • 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="$name" $size />

TWiki Platform Settings

  • TWiki site name:
    • Set WIKITOOLNAME = APS Sahaja Yoga

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

  • Maximum size of FileAttachments in KB, 0 for no limit:
    • 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 =
    • #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 APS Sahaja Yoga 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 APS Sahaja Yoga maintenance.

Search Settings

  • Default type for search, one of: keyword (for search engine like syntax), regex (for RegularExpression search), or literal (for verbatim search)
    • Set SEARCHDEFAULTTTYPE = keyword
  • Default for %SEARCH{}% variable, one of: keyword, regex, or literal
    • Set SEARCHVARDEFAULTTYPE = literal
  • 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

Email and Proxy Server Settings

  • TWiki webmaster email address:
    • Set WIKIWEBMASTER = webmaster

  • TWiki webmaster name (first name and last name, e.g. Fred Smith):
    • Set WIKIWEBMASTERNAME = TWiki Administrator

Email Link Settings

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

HTTP-EQUIV Settings

  • http-equiv meta tags for view, rdiff, attach, search* scripts:
      * #Set HTTP_EQUIV_ON_VIEW = 
      * Set HTTP_EQUIV_ON_VIEW =         <link rel="alternate" type="application/rss+xml" title="RSS Feed" href="%SCRIPTURL%/view%SCRIPTSUFFIX%/%WEB%/WebRss" />

  • http-equiv meta tags for edit script:
      * Set HTTP_EQUIV_ON_EDIT =        

  • http-equiv meta tags for preview script:
      * Set HTTP_EQUIV_ON_PREVIEW =        

Skin Settings

  • Skin overriding the default TWiki templates: (can be overwritten by WebPreferences and user preferences)
    • Set SKIN = pattern

PatternSkin

Skin icons

Legacy support

Plugins Settings

Currently activated plugins: CommentPlugin, EditTablePlugin, HeadlinesPlugin, ImageGalleryPlugin, InterwikiPlugin, PreferencesPlugin, RenderListPlugin, SlideShowPlugin, SmiliesPlugin, SpreadSheetPlugin, TablePlugin

You can enable/disable plugins using the configure interface.

Miscellaneous Settings

  • Line break:
    • Set BR =

  • Bullet sign:
    • Set BULLET = •

  • Line break and bullet with different levels of indentation:
    • Set BB =
    • Set BB2 =
        •
    • Set BB3 =
          •
    • Set BB4 =
            •

  • Colored text: (see more 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 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 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 TWikiDocGraphics. (There are various ways to set up common icons as text variables. This is simply one quick approach.):
    • Set H = help
    • Set I = tip
    • Set M = arrowright
    • Set N = new
    • Set P = pencil
    • Set Q = help
    • Set S = starred
    • Set T = tip
    • Set U = updated
    • Set X = warning
    • Set Y = choice-yes

  • Background color of non existing topic: ( default cornsilk or #FFFFCE )
    • Set NEWTOPICBGCOLOR = #FFFFCE

  • Font color of non existing topic: ( default #0000FF )
    • Set NEWTOPICFONTCOLOR = #0000FF

  • PreviewBackground image:
    • Set PREVIEWBGIMAGE = /wiki/pub/TWiki/PreviewBackground/preview2bg.gif

Access Control Settings

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
  • Preferences are used as TWikiVariables by enclosing the name in percent signs: %. Example:
    • When you write variable %WEBBGCOLOR%, it gets expanded to #FF3366 .

  • warning 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.
  • warning 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

Note: Can't edit? View raw topic

  • logo:
    logo.png

  • Logo:
    logo.png

  • logo.png:
    logo.png

I Attachment Action Size Date Who Comment
logo.pngpng logo.png manage 19.8 K 11 Mar 2006 - 10:32 RoccoVR  
Edit | Attach | Printable | Raw View | Backlinks: Web, All Webs | History: r10 < r9 < r8 < r7 < r6 | More topic actions
This site is powered by the TWiki collaboration platformCopyright © 1993-2005 Associazione di Promozione Sociale "Sahaja Yoga" di Verona
http://www.sahajayogaverona.it - info@sahajayogaveronaPROTEZIONESPAMDACANCELLARE.it
Tel. 3476521542