TWikiPreferences < Sandbox/Sandbox

*%WIKITOOLNAME% Site-Level Preferences*

The following settings are __site-level preferences__ , e.g. affecting all users in all %WIKITOOLNAME% webs. These preferences can be overwritten by __web preferences__ (topic %WEBPREFSTOPIC% in each %WIKITOOLNAME% web) and __user preferences__ (your personal topic, i.e. Main.TWikiGuest in the %WIKITOOLNAME%.%MAINWEB% web)

__Preferences:__

   * List of %WIKITOOLNAME% webs: (the first line of a topic; to add a web see TWikiDocumentation and TWikiWebsTable)
      * Set WIKIWEBLIST = <a href="%WIKIHOMEURL%">%WIKITOOLNAME%</a> . {
          <a href="%SCRIPTURLPATH%/view%SCRIPTSUFFIX%/%MAINWEB%/%HOMETOPIC%">Main</a> 
        | <a href="%SCRIPTURLPATH%/view%SCRIPTSUFFIX%/%TWIKIWEB%/%HOMETOPIC%">TWiki</a> 
        | <a href="%SCRIPTURLPATH%/view%SCRIPTSUFFIX%/Know/%HOMETOPIC%">Know</a> 
        | <a href="%SCRIPTURLPATH%/view%SCRIPTSUFFIX%/Test/%HOMETOPIC%">Test</a> 
        }

   * List of topics of a web: (the second line of a topic, is overwritten by web preferences)
      * Set WEBTOPICLIST = %WEB% . {
            <a href="%HOMETOPIC%">Home</a> 
          | <a href="WebChanges">Changes</a>
          | <a href="%SCRIPTURLPATH%/search%SCRIPTSUFFIX%/%WEB%/?scope=topic&amp;regex=on&amp;search=.*">Index</A>
          | <a href="WebSearch">Search</a>
          | Go <input type="text" name="topic" size="16">
        }

   * Copyright notice:
      * Set WEBCOPYRIGHT = <font size="-2">Copyright &copy; 2000 by the contributing authors. \nAll material on this collaboration tool is the property of the contributing authors. <br> \nIdeas, requests, problems regarding %WIKITOOLNAME%? <a href="mailto:%WIKIWEBMASTER%?subject=%WIKITOOLNAME% Feedback">Send</a> feedback. </font>

   * 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

   * %TWIKIWEB%.PreviewBackground image:
      * Set PREVIEWBGIMAGE = %PUBURLPATH%/%TWIKIWEB%/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 = 70

   * 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 <u>Edit</u> 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 = 

   * 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= or =localhost=
      * Set SMTPMAILHOST = mail

   * http-equiv meta tags for __view__, __rdiff__, __attach__, __search*__ scripts:
<verbatim>
      * Set HTTP_EQUIV_ON_VIEW = 
</verbatim>

   * http-equiv meta tags for __edit__ script. Example to expire immediately: <br> =Set HTTP_EQUIV_ON_EDIT = &lt;meta http-equiv="Expires" content="%<nop>GMTIME{"$day $month, $year - $hour:$min:$sec"}% GMT"&gt;=
<verbatim>
      * Set HTTP_EQUIV_ON_EDIT = 
</verbatim>

   * http-equiv meta tags for __preview__ script:
<verbatim>
      * Set HTTP_EQUIV_ON_PREVIEW = 
</verbatim>

   * Users or groups allowed to change this <nop>%TOPIC% topic: (I.e. %MAINWEB%.TWikiAdminGroup)
      * Set ALLOWTOPICCHANGE = 

   * Site-level preferences that are *not* allowed to be overridden by %WEBPREFSTOPIC% and user preferences:
      * 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.<nop>DefaultPlugin, TWiki.<nop>AnOtherPlugin==)
      * Set ACTIVEPLUGINS = TWiki.DefaultPlugin
      * Set INACTIVEPLUGINS = TWiki.EmptyPlugin

   * Preferences of DefaultPlugin:
      * Allow depreciated =%<nop>INCLUDE:"topic"%= syntax: (=0= or =1=)
         * Set DEFAULTPLUGIN_OLDINCLUDE = 1

__Notes:__
   * A preference is defined as: <br> =6 spaces * Set NAME = value= <br> Example:
      * S<nop>et WEBBGCOLOR = #FFFFC0
   * Preferences are used as %TWIKIWEB%.TWikiVariables by enclosing the name in percent signs. Example:
      * When you write variable =%WEB<nop>BGCOLOR%= , it gets expanded to =%WEBBGCOLOR%= .
   * The sequential order of the preference settings is significant. Define preferences that use other preferences first, i.e. set =<nop>WEBCOPYRIGHT= before =<nop>WIKIWEBMASTER= since =%<nop>WEBCOPYRIGHT%= uses the =%<nop>WIKIWEBMASTER%= variable.
   * You can introduce new variables and use them in your topics and templates. There is no need to change the %WIKITOOLNAME% engine (Perl scripts).

__Related Topics:__
   * %WEBPREFSTOPIC% has preferences of the %WIKITOOLNAME%.%WEB% web.
   * %MAINWEB%.%WIKIUSERSTOPIC% has a list of user topics. User topics can have optional user preferences.
   * %TWIKIWEB%.TWikiVariables has a list of common =%<nop>VARIABLES%= .
   * %TWIKIWEB%.TWikiAccessControl explains how to restrict access by users or groups.
This topic: Sandbox/Sandbox > TWikiPreferences
Topic revision: r11 - 2001-07-14 - PeterThoeny