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

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

• • Set EDITBOXHEIGHT = 15

• • Set EDITBOXHEIGHT = 25

• • Set RELEASEEDITLOCKCHECKBOX =

• • Set RELEASEEDITLOCKCHECKBOX = checked="checked"

• • Set WIKIWEBMASTER = webmaster@your.company

• • Set WIKIWEBMASTER = fanamin@hotmail.com

• • Set SMTPSENDERHOST =

• • Set SMTPSENDERHOST = twiki.jhydra.sourceforge.net

• • Set WIKITOOLNAME = TWikibeta

• • Set WIKITOOLNAME = TWiki

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

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

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

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

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

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

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

• Bullet sign:
  • Set BULLET = •

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

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: TWikiGuest).

• • Set PREVIEWBGIMAGE = /pub/TWiki/PreviewBackground/previewbg.gif

• • Set PREVIEWBGIMAGE = /pub/TWiki/PreviewBackground/preview2bg.gif

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

• • Set MAILTHISTOPIC = Send a link to this page

• • Set MAILTHISTOPIC = Send a link to this page

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

• • Set ORANGE =
    • ORANGE looks like this

• • And finally:

• • And finally:

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

Email Settings

Email and Proxy Server Settings

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

General Preferences

• 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:
    JHydra| Know | Main | Sandbox | TWiki |

Web Preferences

NOTE: They are typically redefined in individual WebPreferences topics

• • Set WEBTOPICLIST = Home | Changes | Index | Search | Go

• • Set WEBTOPICLIST = Changes | Index | Search | Go

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

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

User Settings

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

NOTE: They are typically redefined in topics of individual TWikiUsers

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:
    JHydra| Know | Main | Sandbox | TWiki |

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://jhydra.sourceforge.net/cgi-bin/view/TWiki/TWikiPreferences

• • Set TLS =

• 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/previewbg.gif

• • Set FINALPREFERENCES = PREVIEWBGIMAGE, WIKIWEBMASTER, SMTPMAILHOST , SMTPSENDERHOST, ALLOWWEBMANAGE

• • Set FINALPREFERENCES = PREVIEWBGIMAGE, WIKITOOLNAME, WIKIWEBMASTER, SMTPMAILHOST , SMTPSENDERHOST, ALLOWWEBMANAGE

• Line break:
  • Set BR =
    

• • Set WIKIWEBLIST = Main | TWiki | Know | Sandbox
  • NOTE: To automatically list all non-hidden webs in alphabetical order, use this variable instead:
    Set WIKIWEBLIST = JHydra| Know | Main | Sandbox | TWiki |

• • Set WIKIWEBLIST = Main | TWiki | Know | Sandbox
  • NOTE: To automatically list all non-hidden webs in alphabetical order, use the %WEBLIST{}% variable instead:
    JHydra| Know | Main | Sandbox | TWiki |

• Style of text edit box. Set to width: 100% 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: 100%

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

• Style of text edit box. Set to width: 100% for full window width (which will overwrite the EDITBOXWIDTH setting), or width: auto to disable (default). This setting works for IE and some other recent browsers. (can be overwritten by user preferences)
  • Set EDITBOXSTYLE = width: auto

• Style of text edit box. Set to width: 100% 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: 100%

TWiki Site-Level Preferences

TWiki Site-Level Preferences

• Style of text edit box. Set to width: 100% for full window width (which will overwrite the EDITBOXWIDTH setting), or width: auto to disable (default). This setting works for IE and some other recent browsers. (can be overwritten by user preferences)
  • Set EDITBOXSTYLE = width: auto

Preferences Access Control

Access Control Settings

• • Set ALLOWWEBCREATEWEB = TWikiAdminGroup

• • Set ALLOWWEBMANAGE = TWikiAdminGroup

• • Set FINALPREFERENCES = PREVIEWBGIMAGE, WIKIWEBMASTER, SMTPMAILHOST , SMTPSENDERHOST, ALLOWWEBCREATEWEB

• • Set FINALPREFERENCES = PREVIEWBGIMAGE, WIKIWEBMASTER, SMTPMAILHOST , SMTPSENDERHOST, ALLOWWEBMANAGE

• • Set WIKIWEBLIST = Main | TWiki | Know | Test?

• • Set WIKIWEBLIST = Main | TWiki | Know | Sandbox

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

• Users or groups allowed to create new webs: (ex: TWikiAdminGroup)
  • Set ALLOWWEBCREATEWEB = TWikiAdminGroup

• • Set FINALPREFERENCES = PREVIEWBGIMAGE, WIKIWEBMASTER, SMTPMAILHOST , SMTPSENDERHOST

• • Set FINALPREFERENCES = PREVIEWBGIMAGE, WIKIWEBMASTER, SMTPMAILHOST , SMTPSENDERHOST, ALLOWWEBCREATEWEB

• List of TWiki webs - on the first line of the upper toolbar (to add a new web, see ManagingWebs and TWikiWebsTable):

• List of TWiki webs - on the first line of the upper toolbar (to add a new web, see ManagingWebs and SiteMap):

General Preferences:

General Preferences

Miscellaneous Settings

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

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

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

• • Set ATTACHEDFILELINKFORMAT = \t* $name: $comment

• • Set ATTACHEDFILELINKFORMAT = \t* $name: $comment

• • Set ATTACHEDIMAGEFORMAT = \t* $comment:
    
  • NOTE: Example image is broken because there is no attached image file.

      * Set ATTACHEDIMAGEFORMAT = \t* $comment: <br />
        <img src="%ATTACHURLPATH%/$name" alt="$name" $size />

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

• 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 ATTACHEDIMAGEFORMAT = \t* $comment:
    Example image is broken because there is no attached image file.

• • Set ATTACHEDIMAGEFORMAT = \t* $comment:
    
  • NOTE: Example image is broken because there is no attached image file.

TWiki Site-Level Preferences

TWiki Site-Level Preferences

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

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

General Preferences:

Preferences:

• List of TWiki webs: (the first line of a topic; to add a web see TWikiDocumentation and TWikiWebsTable)

• List of TWiki webs - on the first line of the upper toolbar (to add a new web, see ManagingWebs and TWikiWebsTable):

• • Note: To automatically list all non-hidden webs in alphabetical order you can use this variable instead: Set WIKIWEBLIST = JHydra| Know | Main | Sandbox | TWiki |

• • NOTE: To automatically list all non-hidden webs in alphabetical order, use this variable instead:
    Set WIKIWEBLIST = JHydra| Know | Main | Sandbox | TWiki |

• List of topics of a web: (the second line of a topic, is overwritten by web preferences)

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

• • Note: Keyword $name gets expanded to filename; $comment to comment; \t to tab (3 spaces for bullets).

• • NOTE: Keyword $name gets expanded to filename; $comment to comment; \t to tab (3 spaces for bullets).

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

• • Set ATTACHEDIMAGEFORMAT = \t* $comment:
    Example image is broken because there is no attached image file.
  • 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).

Email Settings

• Wiki webmaster email address:

• TWiki webmaster email address:

• 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

• 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

• 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

• 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

Plugins Settings

• • Note: In case you have a rough plugin you can disable all plugins with the $disableAllPlugins flag in the TWiki.cfg file.

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

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

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

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

• http-equiv meta tags for preview script:

• http-equiv meta tags for preview script:

• Users or groups allowed to change or rename this TWikiPreferences topic: (I.e. TWikiAdminGroup)

Preferences Access Control

• Users or groups allowed to change or rename this TWikiPreferences topic: (ex: TWikiAdminGroup)

Creating New Preference Variables

Notes:

• A preference is defined as:
  6 spaces * Set NAME = value
  Example:

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):

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

• 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. For example, set WEBCOPYRIGHT before WIKIWEBMASTER since the copyright notice uses the webmaster email address.

Related Topics

Related Topics:

• Mail host for outgoing mail. This is used for WebChangesAlert if Perl module Net::SMTP is installed. If not, sendmail is used instead (defined by $mailProgram in TWiki.cfg). Examples: mail.your.company or localhost

• 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

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

• • Set FINALPREFERENCES = PREVIEWBGIMAGE, WIKIWEBMASTER, MAILHOST

• • Set FINALPREFERENCES = PREVIEWBGIMAGE, WIKIWEBMASTER, SMTPMAILHOST , SMTPSENDERHOST

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

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

• Mail host for outgoing mail. This is used for WebNotification? if Perl module Net::SMTP is installed. If not, sendmail is used instead (defined by $mailProgram in TWiki.cfg). Examples: mail.your.company or localhost

• Mail host for outgoing mail. This is used for WebChangesAlert if Perl module Net::SMTP is installed. If not, sendmail is used instead (defined by $mailProgram in TWiki.cfg). Examples: mail.your.company or localhost

• Users or groups allowed to change this TWikiPreferences topic: (I.e. TWikiAdminGroup)

• Users or groups allowed to change or rename this TWikiPreferences topic: (I.e. TWikiAdminGroup)

• Users or groups allow to rename this TWikiPreferences topic:
  • #Set ALLOWTOPICRENAME = TWikiAdminGroup

• • Set ALLOWTOPICRENAME =

• Mail host for outgoing mail. This is used for TWikiNotificationOfChanges? if Perl module Net::SMTP is installed. If not, sendmail is used instead (defined by $mailProgram in TWiki.cfg). Examples: mail.your.company or localhost

• Mail host for outgoing mail. This is used for WebNotification? if Perl module Net::SMTP is installed. If not, sendmail is used instead (defined by $mailProgram in TWiki.cfg). Examples: mail.your.company or localhost

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

• • Set ALLOWTOPICRENAME = NobodyGroup

• • #Set ALLOWTOPICRENAME = TWikiAdminGroup

• Users or groups allow to rename this TWikiPreferences topic:
  • Set ALLOWTOPICRENAME = NobodyGroup

• • Set WIKIWEBLIST = TWiki . { Main | TWiki | Know | Test }

• • Set WIKIWEBLIST = Main | TWiki | Know | Test?
  • Note: To automatically list all non-hidden webs in alphabetical order you can use this variable instead: Set WIKIWEBLIST = JHydra| Know | Main | Sandbox | TWiki |

• • Set WEBTOPICLIST = TWiki . { Home | Changes | Index | Search | Go }

• • Set WEBTOPICLIST = Home | Changes | Index | Search | Go

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

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

• 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, InterwikiPlugin
  • Note: In case you have a rough plugin you can disable all plugins with the $disableAllPlugins flag in the TWiki.cfg file.

Plugin Preferences:

• Installed TWikiPlugins: To enable/disable plugins, move them between ACTIVEPLUGINS and INACTIVEPLUGINS. Specify a comma separated list of plugin topics; the name of the web must be specified (i.e. TWiki.DefaultPlugin, TWiki.AnOtherPlugin)
  • Set ACTIVEPLUGINS = DefaultPlugin
  • Set INACTIVEPLUGINS = EmptyPlugin

• Preferences of DefaultPlugin:
  • Allow depreciated %INCLUDE:"topic"% syntax: (0 or 1)
    • Set DEFAULTPLUGIN_OLDINCLUDE = 1

• Default state of the Release edit lock 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)

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

• 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. Check box is initially checked if Set ATTACHLINKBOX = CHECKED , 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)

• Default state of the Release edit lock 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 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)

• Mail host for outgoing mail. This is used for TWikiNotificationOfChanges? if Perl module Net::SMTP is installed. If not, sendmail is used instead (defined by $mailProgram in TWiki.cfg). Examples: mail.your.company, localhost

• Mail host for outgoing mail. This is used for TWikiNotificationOfChanges? if Perl module Net::SMTP is installed. If not, sendmail is used instead (defined by $mailProgram in TWiki.cfg). Examples: mail.your.company or localhost

• Wiki webmaster email address:
  • Set WIKIWEBMASTER = webmaster@your.company

• Wiki webmaster email address:
  • Set WIKIWEBMASTER = webmaster@your.company

• Mail host for outgoing mail. This is used for TWikiNotificationOfChanges? if Perl module Net::SMTP is installed. If not, sendmail is used instead (defined by $mailProgram in TWiki.cfg). Examples: mail.your.company, localhost
  • Set SMTPMAILHOST = mail

• • Set FINALPREFERENCES = WIKIWEBMASTER, PREVIEWBGIMAGE

• • Set FINALPREFERENCES = PREVIEWBGIMAGE, WIKIWEBMASTER, MAILHOST

Plugin Preferences:

• Installed TWikiPlugins: To enable/disable plugins, move them between ACTIVEPLUGINS and INACTIVEPLUGINS. Specify a comma separated list of plugin topics; the name of the web must be specified (i.e. TWiki.DefaultPlugin, TWiki.AnOtherPlugin)
  • Set ACTIVEPLUGINS = DefaultPlugin
  • Set INACTIVEPLUGINS = EmptyPlugin

• Preferences of DefaultPlugin:
  • Allow depreciated %INCLUDE:"topic"% syntax: (0 or 1)
    • Set DEFAULTPLUGIN_OLDINCLUDE = 1

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

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

Main | TWiki | Know | Test

Main | TWiki | Know | Test

Home

Home

• Site-level preferences that are not allowed to be overridden by WebPreferences and user preferences:

• Site-level preferences that are not allowed to be overridden by WebPreferences and user preferences:

• • Set WIKIWEBMASTER = Peter@Thoeny.com

• • Set WIKIWEBMASTER = webmaster@your.company

• Users or groups allowed to change this TWikiPreferences topic: (I.e. TWikiAdminGroup)
  • Set ALLOWTOPICCHANGE =

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

• TWikiAccessControl explains how to restrict access by users or groups.

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

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

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

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

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

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 = TWiki . { Main | TWiki | Know | Test }

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

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

• Wiki webmaster email address:
  • Set WIKIWEBMASTER = Peter@Thoeny.com

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

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

• 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

• Default state of the link check box in the attach file page. Check box is initially checked if Set ATTACHLINKBOX = CHECKED , 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 =

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

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