TWiki

~~Edit~~
~~Attach~~
Printable

TWiki.TWikiPreferencesr1.1 - 10 Nov 2004 - 17:59 - TWikiGuesttopic end

TWiki Site-Level Preferences

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), and on the user level (create preferences in your user account topic in the Main web, ex: Main.guest).

NOTE: You can lock individual settings at the site or web levels using User & Group Access Control - see section below.

Web Preferences
User Settings
TWiki Platform Settings
Email and Proxy Server Settings
- Email Link Settings
Plugins Settings
HTTP-EQUIV Settings
Miscellaneous Settings
Access Control Settings
Creating New Preference Variables
Related Topics

Web Preferences

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):
- Set WEBTOPICLIST = Changes | Index | Search | Go

Copyright notice:
- Set WEBCOPYRIGHT = Copyright © 1999-2002 by the contributing authors. \nAll material on this collaboration tool is the property of the contributing authors.
  \nIdeas, requests, problems regarding TWiki? Send feedback.

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

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

User Settings

NOTE: They are typically redefined in topics of individual TWikiUsers

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 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 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)
- 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)
- 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 platform name:
- Set WIKITOOLNAME = TWikibeta

Image, URL and alternate tooltip text of TWiki logo: (can be overwritten by web preferences)
- Set WIKILOGOIMG =
- Set WIKILOGOURL = http://TWiki.org/
- Set WIKILOGOALT = TWiki home

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 | Know^? | Sandbox
- NOTE: To automatically list all non-hidden webs in alphabetical order, use the %WEBLIST{}% variable instead:
  Main <span class=Sandbox <span class=TWiki

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

Email and Proxy Server Settings

TWiki webmaster email address:
- Set WIKIWEBMASTER = webmaster@your.company

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
- Set MAILTHISTOPIC = Send a link to this page

'Mail this topic' link text
- Set MAILTHISTOPICTEXT = Send a link to this page

URL for current topic
- Set TOPICURL = http://pyqplayer.sourceforge.net/cgi-bin/bin/view/TWiki/TWikiPreferences

Plugins Settings

TWikiPlugins configuration: All plugin modules that exist in the lib/TWiki/Plugins directory are activated automatically unless disabled by DISABLEDPLUGINS. You can optionally list the installed plugins in INSTALLEDPLUGINS. This is useful to define the sequence of plugin execution, or to specify other webs then the TWiki web for the plugin topics. Specify plugins as a comma separated list of topics.
- Set INSTALLEDPLUGINS = DefaultPlugin
- Set DISABLEDPLUGINS = EmptyPlugin
- Currently activated plugins: DefaultPlugin, SpreadSheetPlugin, CommentPlugin, EditTablePlugin, InterwikiPlugin, RenderListPlugin, SlideShowPlugin, SmiliesPlugin, TablePlugin
- NOTE: You can enable/disable all plugins with the $disableAllPlugins flag in the lib/TWiki.cfg file.

HTTP-EQUIV Settings

http-equiv meta tags for view, rdiff, attach, search* scripts:

      * Set HTTP_EQUIV_ON_VIEW =

http-equiv meta tags for edit script. Example, to expire immediately:
Set HTTP_EQUIV_ON_EDIT = <meta http-equiv="Expires" content="%GMTIME{"$day $month $year $hour:$min:$sec"}% GMT">

      * Set HTTP_EQUIV_ON_EDIT =

http-equiv meta tags for preview script:

      * Set HTTP_EQUIV_ON_PREVIEW =

Miscellaneous Settings

Line break:
- Set BR =

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 =
  - YELLOW looks like this
- Set ORANGE =
  - ORANGE looks like this
- Set RED =
  - RED looks like this
- Set PINK =
  - PINK looks like this
- Set PURPLE =
  - PURPLE looks like this
- Set TEAL =
  - TEAL looks like this
- Set NAVY =
  - NAVY looks like this
- Set BLUE =
  - BLUE looks like this
- Set AQUA =
  - AQUA looks like this
- Set LIME =
  - LIME looks like this
- Set GREEN =
  - GREEN looks like this
- Set OLIVE =
  - OLIVE looks like this
- Set MAROON =
  - MAROON looks like this
- Set BLACK =
  - BLACK looks like this
- Set GRAY =
  - GRAY looks like this
- Set SILVER =
  - SILVER looks like this
- Set WHITE =
  - WHITE looks like this
- And finally:
- Set ENDCOLOR =
  - To finish colored text

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 =
- Set I =
- Set M =
- Set N =
- Set P =
- Set Q =
- Set S =
- Set T =
- Set U =
- Set X =
- Set Y =

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 = /pub/TWiki/PreviewBackground/preview2bg.gif

Access Control Settings

Users or groups allowed to change or rename this TWikiPreferences topic: (ex: TWikiAdminGroup)
- Set ALLOWTOPICCHANGE =
- Set ALLOWTOPICRENAME =

Users or groups allowed to create new webs: (ex: TWikiAdminGroup)
- Set ALLOWWEBMANAGE = TWikiAdminGroup

Site-level preferences that are not allowed to be overridden by WebPreferences and user preferences:
- Set FINALPREFERENCES = PREVIEWBGIMAGE, WIKITOOLNAME, WIKIWEBMASTER, SMTPMAILHOST , SMTPSENDERHOST, ALLOWWEBMANAGE

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 #FFD8AA .

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.

You type:	`%RED% red text %ENDCOLOR% and %GREEN% green text %ENDCOLOR%`
You get:	red text and green text