TWikiPreferences - TWiki - b r a y d e n . o r g

TWiki Site-Level Preferences

The following settings are site-level preferences , e.g. affecting all users in all TWiki webs. These preferences can be overwritten by web preferences (topic WebPreferences in each TWiki web) and user preferences (your personal topic, i.e. TWikiGuest in the TWiki.Main web)

Preferences:

List of TWiki webs: (the first line of a topic; to add a web see TWikiDocumentation and TWikiWebsTable)
- Set WIKIWEBLIST = Random | Software | Books | Main | TWiki

List of topics of a web: (the second line of a topic, is overwritten by web preferences)
- Set WEBTOPICLIST = Home | Changes | Index | Search | Go

Copyright notice:
- Set WEBCOPYRIGHT = Copyright © 2003-2011 by the original authors. \nAll material on this collaboration tool is the property of the original 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

PreviewBackground image:
- Set PREVIEWBGIMAGE = /twiki/pub/TWiki/PreviewBackground/previewbg.gif

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

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

Horizontal size of text edit box: (can be overwritten by user preferences)
- Set EDITBOXWIDTH = 100

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

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

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

Format of file link when the link check box is checked: (can be overwritten by user preferences)
- Set ATTACHEDFILELINKFORMAT = \t* $name: $comment
- Note: Keyword $name gets expanded to filename; $comment to comment; \t to tab (3 spaces for bullets).

Format of images when the link check box is checked: (can be overwritten by user preferences)
- Set ATTACHEDIMAGEFORMAT = \t* $comment:
- Note: Above image is shown as broken, it gets expanded correctly when you attach an image.
- 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).

Wiki webmaster email address:
- Set WIKIWEBMASTER = webmaster@brayden.org

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.brayden.org

Mail domain sending mail. SMTP requires that you identify the TWiki server sending mail. If not set, Net::SMTP will guess it for you. Examples: twiki.your.company
- Set SMTPSENDERHOST = mail.brayden.org

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, InterwikiPlugin, StylePlugin, TreePlugin, HeadlinesPlugin
- Set DISABLEDPLUGINS = EmptyPlugin
- Currently activated plugins: DefaultPlugin, InterwikiPlugin, StylePlugin, TreePlugin, HeadlinesPlugin, SlideShowPlugin
- Note: In case you have a rough plugin you can disable all plugins with the $disableAllPlugins flag in the TWiki.cfg file.

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 =

Users or groups allowed to change or rename this TWikiPreferences topic: (I.e. TWikiAdminGroup)
- Set ALLOWTOPICCHANGE = TWikiAdminGroup, DaleBrayden
- Set ALLOWTOPICRENAME = TWikiAdminGroup, DaleBrayden

Users or groups allowed to change or rename topics generally
- Set ALLOWWEBCHANGE = TWikiAdminGroup, DaleBrayden

The skin - choices are void, phantom, and ambar
- Set SKIN = void
Site-level preferences that are not allowed to be overridden by WebPreferences and user preferences:
- Set FINALPREFERENCES = PREVIEWBGIMAGE, WIKIWEBMASTER, SMTPMAILHOST , SMTPSENDERHOST

Customizations for the void skin
- Set SITETITLE = b r a y d e n . o r g
- Set NAVTITLEFIRST = This Web
- Set NAVTITLESECOND = All Webs
- Set NAVTITLETHIRD = brayden.org
- Set NAVTITLEFOURTH = Other
- Set SITECOPYRIGHT = © 2003-2011 by the contributing authors.
size can be sizefixed or sizable
- Set VOIDSKINSIZE = sizefixed

color can be grey, blue, green, red, or black
- Set VOIDSKINCOLOR = blue
- Set WEBNAVLINKS = WebHome
  Topic List
  Web Statistics
- Set OTHERWEBS =
- Set LOCALLINKS = Home
  Monthly Digest
  Today's Links
  Resumé
  Reading List
  Books RSS
  Random RSS
  Software RSS
- Set EXTERNALLINKS = Dale's Blog
  
  TextDrive
ambar skin defaults and preferences
- Set WEBDESC = TWiki
flexible skin preferences
- Set WEBTITLE = b r a y d e n . o r g
disable some rendering for some skins
- Set NONRENDEREDSKINS = rss,cdf
Sample Text
- Set SAMPLETEXT = Lorem ipsum dolor sit amet, consectetaur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum Et harumd und lookum like Greek to me, dereud facilis est er expedit distinct. Nam liber te conscient to factor tum poen legum odioque civiuda. Et tam neque pecun modut est neque nonor et imper ned libidig met, consectetur adipiscing elit, sed ut labore et dolore magna aliquam.
Google Search Form
- Set GOOGLESEARCH =
Useful images
- Set XMLIMAGE =

Notes:

A preference is defined as:
6 spaces * Set NAME = value
Example:
- 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 #FFE0B0 .
The sequential order of the preference settings is significant. Define preferences that use other preferences first, i.e. set WEBCOPYRIGHT before WIKIWEBMASTER since %WEBCOPYRIGHT% uses the %WIKIWEBMASTER% variable.
You can introduce new variables and use them in your topics and templates. There is no need to change the TWiki engine (Perl scripts).

Related Topics:

WebPreferences has preferences of the TWiki.TWiki web.
TWikiUsers has a list of user topics. User topics can have optional user preferences.
TWikiVariables has a list of common %VARIABLES% .
TWikiAccessControl explains how to restrict access by users or groups.

b r a y d e n . o r g / TWiki