TWiki > TWiki > TWikiPreferences (r1.1)	TWiki webs: Main | TWiki | Know | Sandbox
	TWiki . { Welcome | Register | Changes | Topics | Index | Search | Go }

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