(r46) TWikiPreferences < Sandbox

Tags: view all tags
---+!! %WIKITOOLNAME% Site-Level Preferences

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 %WEBPREFSTOPIC% in each web), and on the __user level__ (create preferences in your user account topic in the %MAINWEB% web, ex: %WIKIUSERNAME%).
   * %X% *NOTE:* You can lock individual settings at the site or web levels using User & Group Access Control - see section below.
%TOC%


---++ Web Preferences

%X% *NOTE:* They are typically redefined in individual <nop>WebPreferences topics

   * List of selected topics in a web - the second line of the upper toolbar (usually overwritten in individual %WEBPREFSTOPIC%):
      * Set WEBTOPICLIST = [[WebChanges][Changes]] %SEP% [[WebIndex][Index]] %SEP% [[WebSearch][Search]] %SEP% Go <input type="text" name="topic" size="16" />

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

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

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

   * Prevent automatic linking of [[%TWIKIWEB%.WikiWords][WikiWords]] and acronyms (if set to =on=); link <nop>WikiWords (if empty); can be overwritten by web preferences:
      * Set NOAUTOLINK = 
      * __Note:__ Use the =[<nop>[...][...]]= syntax to link topics in case you disabled <nop>WikiWord linking. The =&lt;noautolink&gt; ... &lt;/noautolink&gt;= syntax can be used to prevents links within a block of text.


---++ User Settings

%X% *NOTE:* They are typically redefined in topics of individual %MAINWEB%.TWikiUsers

   * 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

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

   * 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)
      * %H% *NOTE:* Keyword ==$name== gets expanded to filename; ==$comment== to comment; ==\t== to tab (3 spaces for bullets).
      * Set ATTACHEDFILELINKFORMAT = \t* [[%ATTACHURL%/$name][$name]]: $comment

   * Format of images when the __link__ check box is checked: (can be overwritten by user preferences)
      * %H% *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).
<verbatim>
      * Set ATTACHEDIMAGEFORMAT = \t* $comment: <br />
        <img src="%ATTACHURLPATH%/$name" alt="$name" $size />
</verbatim>


---++ 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 = %PUBURL%/%TWIKIWEB%/TWikiLogos/twikiRobot46x50.gif
      * Set WIKILOGOURL = http://TWiki.org/
      * Set WIKILOGOALT = TWiki home

   * List of %WIKITOOLNAME% webs - on the first line of the upper toolbar (to add a new web, see ManagingWebs and %TWIKIWEB%.SiteMap):
      * Set WIKIWEBLIST = [[%MAINWEB%.%HOMETOPIC%][%MAINWEB%]] %SEP% [[%TWIKIWEB%.%HOMETOPIC%][%TWIKIWEB%]] %SEP% [[Know.%HOMETOPIC%][Know]] %SEP% [[Sandbox.%HOMETOPIC%][Sandbox]]
      * %T% *NOTE:* To automatically list all non-hidden webs in alphabetical order, use the =%<nop>WEBLIST{}%= variable instead: <br />
        %WEBLIST{"[[$name.%HOMETOPIC%][$name]]" separator=" %SEP% "}%

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


---++ Email and Proxy Server Settings

   * TWiki webmaster email address:
      * Set WIKIWEBMASTER = webmaster@your.company

   * 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

   * 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==
      * Set SMTPSENDERHOST = 

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


---+++ Email Link Settings

   * 'Mail this topic' mailto: link - can be included in topics, templates or skins
      * Set MAILTHISTOPIC = [[mailto:?subject=%BASETOPIC%&amp;body=%TOPICURL% %MAILTHISTOPICTEXT%]]

   * 'Mail this topic' link text
      * Set MAILTHISTOPICTEXT = Send a link to this page

   * URL for current topic
      * Set TOPICURL = %SCRIPTURL%/view%SCRIPTSUFFIX%/%WEB%/%BASETOPIC%


---++ Plugins Settings

   * 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%
      * %T% *NOTE:* You can enable/disable all plugins with the ==$disableAllPlugins== flag in the ==lib/TWiki.cfg== file.


---++ HTTP-<nop>EQUIV Settings

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


---++ Miscellaneous Settings

   * Line break:
      * Set BR = <br />

   * Bullet sign:
      * Set BULLET = &#8226;

   * Colored text: (see more StandardColors)
     | You type: | =%<nop>RED% red text %<nop>ENDCOLOR% and %<nop>GREEN% green text %<nop>ENDCOLOR%= |
     | You get: | %RED% red text %ENDCOLOR% and %GREEN% green text %ENDCOLOR% |
      * __Note:__ =%&lt;color&gt;%= text must end with =%<nop>ENDCOLOR%= . If you want to switch from one color to another one you first need to end the active color with =%<nop>ENDCOLOR%=, e.g. write =%<nop>RED% some text %<nop>ENDCOLOR% %<nop>GREEN% more text %<nop>ENDCOLOR%=.
      * Set YELLOW = <font color="#ffff00">
         * *YELLOW looks like this* </font>
      * Set ORANGE = <font color="#ff6600">
         * *ORANGE looks like this* </font>
      * Set RED = <font color="#ff0000">
         * *RED looks like this* </font>
      * Set PINK = <font color="#ff00ff">
         * *PINK looks like this* </font>
      * Set PURPLE = <font color="#800080">
         * *PURPLE looks like this* </font>
      * Set TEAL = <font color="#008080">
         * *TEAL looks like this* </font>
      * Set NAVY = <font color="#000080">
         * *NAVY looks like this* </font>
      * Set BLUE = <font color="#0000ff">
         * *BLUE looks like this* </font>
      * Set AQUA = <font color="#00ffff">
         * *AQUA looks like this* </font>
      * Set LIME = <font color="#00ff00">
         * *LIME looks like this* </font>
      * Set GREEN = <font color="#008000">
         * *GREEN looks like this* </font>
      * Set OLIVE = <font color="#808000">
         * *OLIVE looks like this* </font>
      * Set MAROON = <font color="#800000">
         * *MAROON looks like this* </font>
      * Set BLACK = <font color="#000000">
         * *BLACK looks like this* </font>
      * Set GRAY = <font color="#808080">
         * *GRAY looks like this* </font>
      * Set SILVER = <font color="#c0c0c0">
         * *SILVER looks like this* </font>
      * Set WHITE = <font color="#ffffff">
         * *WHITE looks like this* </font>
      * And finally:<font>
      * Set ENDCOLOR = </font>
         * To finish colored text

#DocGraphics
   * Graphics used in TWiki documentation - view all images in %TWIKIWEB%.TWikiDocGraphics. _(There are various ways to set up common icons as text variables. This is simply one quick approach.)_:
      * Set H = <img src="%PUBURL%/%TWIKIWEB%/TWikiDocGraphics/help.gif" border="0" alt="HELP" width="16" height="16" />
      * Set I = <img src="%PUBURL%/%TWIKIWEB%/TWikiDocGraphics/tip.gif" border="0" alt="IDEA!" width="16" height="16" />
      * Set M = <img src="%PUBURL%/%TWIKIWEB%/TWikiDocGraphics/arrowright.gif" border="0" alt="MOVED TO..." width="16" height="16" />
      * Set N = <img src="%PUBURL%/%TWIKIWEB%/TWikiDocGraphics/new.gif" border="0" alt="NEW" width="28" height="8" />
      * Set P = <img src="%PUBURL%/%TWIKIWEB%/TWikiDocGraphics/pencil.gif" border="0" alt="REFACTOR" width="16" height="16" />
      * Set Q = <img src="%PUBURL%/%TWIKIWEB%/TWikiDocGraphics/help.gif" border="0" alt="QUESTION?" width="16" height="16" />
      * Set S = <img src="%PUBURL%/%TWIKIWEB%/TWikiDocGraphics/starred.gif" border="0" alt="PICK" width="16" height="16" />
      * Set T = <img src="%PUBURL%/%TWIKIWEB%/TWikiDocGraphics/tip.gif" border="0" alt="TIP" width="16" height="16" />
      * Set U = <img src="%PUBURL%/%TWIKIWEB%/TWikiDocGraphics/updated.gif" border="0" alt="UPDATED" width="56" height="8" />
      * Set X = <img src="%PUBURL%/%TWIKIWEB%/TWikiDocGraphics/warning.gif" border="0" alt="ALERT!" width="16" height="16" />
      * Set Y = <img src="%PUBURL%/%TWIKIWEB%/TWikiDocGraphics/choice-yes.gif" border="0" alt="DONE" width="16" height="16" />

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

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

   * %TWIKIWEB%.PreviewBackground image:
      * Set PREVIEWBGIMAGE = %PUBURLPATH%/%TWIKIWEB%/PreviewBackground/preview2bg.gif


---++ Access Control Settings

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

   * Users or groups allowed to [[%TWIKIWEB%.ManagingWebs][create new webs]]: (ex: %MAINWEB%.TWikiAdminGroup)
      * Set ALLOWWEBMANAGE = %MAINWEB%.TWikiAdminGroup

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


---++ Creating New Preference Variables
 
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== <br /> Example (as a nested bullet item, indented 6 spaces):
      * 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%= .

   * %X% The sequential order of the preference settings is significant. Define preferences that use other preferences FIRST. For example, set ==<nop>WEBCOPYRIGHT== before ==<nop>WIKIWEBMASTER== since the copyright notice uses the webmaster email address.


---++ 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.
Topic revision: r46 - 2003-01-25 - PeterThoeny