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 = [[%MAINWEB%.%HOMETOPIC%][Main]] %SEP% [[%TWIKIWEB%.%HOMETOPIC%][TWiki]] %SEP% [[Know.%HOMETOPIC%][Know]] %SEP% [[Test.%HOMETOPIC%][Test]]
      * __Note:__ To automatically list all non-hidden webs in alphabetical order you can use this variable instead: Set WIKIWEBLIST = %WEBLIST{"[[$name.%HOMETOPIC%][$name]]" separator=" %SEP% "}%

   * List of topics of a web: (the second line of a topic, is overwritten by web preferences)
      * Set WEBTOPICLIST = [[%HOMETOPIC%][Home]] %SEP% [[WebChanges][Changes]] %SEP% [[WebIndex][Index]] %SEP% [[WebSearch][Search]] %SEP% 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%&#32;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 = 

   * Format of file link when the __link__ check box is checked: (can be overwritten by user preferences)
      * Set ATTACHEDFILELINKFORMAT = \t* [[%ATTACHURL%/$name][$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: <br /> <img src="%ATTACHURLPATH%/$name" alt="$name" $size />
      * __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@your.company

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

   * 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 %TWIKIWEB% web for the plugin topics. Specify plugins as a comma separated list of topics.
      * Set INSTALLEDPLUGINS = TWiki.DefaultPlugin
      * Set DISABLEDPLUGINS = EmptyPlugin
      * Currently activated plugins: %ACTIVATEDPLUGINS%
      * __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:
<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 or rename this <nop>%TOPIC% topic: (I.e. %MAINWEB%.TWikiAdminGroup)
      * Set ALLOWTOPICCHANGE = 
      * Set ALLOWTOPICRENAME = 

   * Site-level preferences that are *not* allowed to be overridden by %WEBPREFSTOPIC% and user preferences:
      * Set FINALPREFERENCES = PREVIEWBGIMAGE, WIKIWEBMASTER, MAILHOST


__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: r18 - 2001-09-09 - PeterThoeny