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 = Main | TWiki | Test
    • Note: To automatically list all non-hidden webs in alphabetical order you can use this variable instead: Set WIKIWEBLIST = Main| TWiki | Test | Trash? |

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

  • Copyright notice:

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

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

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

  • 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)
    • 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:
      $name
    • 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).

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

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

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

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

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: