%WIKITOOLNAME% Site-Level Preferences

This topic defines site-level settings that apply to all users and webs on this [[Main/TWikiSite]].

%X% Note: This topic should be regarded as read-only, so that upgrades can safely overwrite it without risk to your customizations.

Preference settings local to your site should be set in [[Main/TWikiPreferences]] (this topic is pointed to by {LocalSitePreferences}, which is set by the admin in the configure interface). Settings in [[Main/TWikiPreferences]] will override settings in this topic, and should be used for defining custom settings and variables.

[[Main/TWikiVariables#PreferencesVariables]] on how to set Preferences Variables.

(Click for form-based editing of existing preferences.)

Default Web Preferences

%X% NOTE: These are just defaults; don't change them here. Instead, add them to the WebPreferences topic in each web

Default User Settings

%X% NOTE: They are typically redefined in topics of individual [[Main/TWikiUsers]]

      * Set ATTACHEDFILELINKFORMAT = \n   * [[%ATTACHURL%/$name][$name]]: $comment

      * Set ATTACHEDIMAGEFORMAT = \n   * $comment: <br />\n     <img src="%ATTACHURLPATH%/$name" alt="$name" $size />

TWiki Platform Settings

Search Settings

E-mail Settings

HTTP-EQUIV Settings

- **http-equiv** meta tags for **edit** script: - Set HTTP\_EQUIV\_ON\_EDIT = - **http-equiv** meta tags for **preview** script: - Set HTTP\_EQUIV\_ON\_PREVIEW = ## Skin Settings - Skin overriding the default TWiki templates: (can be overwritten by [[WebPreferences]] and user preferences) - Set SKIN = pattern - **_Note:_** See [[TWikiSkinBrowser]] for currently installed skins ### [[PatternSkin]] - Default TWiki styles - Set TWIKILAYOUTURL = - Set TWIKISTYLEURL = - Set TWIKICOLORSURL = - Custom overriding styles (enabled pr. default but empty, to prevent browsers from fetching %USERLAYOUTURL%-style URLs) - Set USERLAYOUTURL = - Set USERSTYLEURL = - Set USERCOLORSURL = - **PatternSkin header settings** - Set WEBHEADERART = ![TWiki\_header.gif](http://www.dementia.org/twiki//view/TWiki/PatternSkin/TWiki_header.gif) - Set WEBHEADERBGCOLOR = #ffffff ### Skin icons - Topic containing the icon graphics library. Icons can easily be rendered with `%ICON{name}%`. - Set ICONTOPIC = [[TWikiDocGraphics]] ### Legacy support - Support for legacy "EDITTOPIC", used to be hard-coded, now replaced by TMPL:P conditional instantiation - Set EDITURL = - Set EDITTOPIC = [Edit](%EDITURL% Edit Topic - deprecated usage - please see release notes) ## Plugins Settings - You can enable/disable Plugins using the [configure](http://www.dementia.org/twiki/configure) interface. - You can also disable installed plugins in individual webs/topics by defining the %DISABLEDPLUGINS% TWiki variable to be a list of plugins to disable e.g. - Set DISABLEDPLUGINS = [[SpreadSheetPlugin]],EditTablePlugin - Currently, %DISABLEDPLUGINS% is set to "%DISABLEDPLUGINS%" - Currently activated Plugins: [[SpreadSheetPlugin]], [[CommentPlugin]], [[EditTablePlugin]], [[InterwikiPlugin]], [[PreferencesPlugin]], [[SlideShowPlugin]], [[SmiliesPlugin]], [[TablePlugin]], [[TwistyPlugin]] - %T% **NOTE:** You can enable/disable Plugins by passing a comma-separated list of Plugin names in the `debugenableplugins` url parameter; for example, [[http://www.dementia.org/twiki/view/%WEB%/%TOPIC%?debugenableplugins=SmiliesPlugin|%WEB%/%TOPIC%?debugenableplugins=SmiliesPlugin]] will display this topic with all Plugins disabled except the [[SmiliesPlugin]]. - Detailed diagnostics can be found in [[InstalledPlugins]] - Legacy settings: - Set INSTALLEDPLUGINS = The INSTALLEDPLUGINS variable is no longer supported. You can set the Plugins execution order using the [configure](http://www.dementia.org/twiki/configure) interface. ## Rendering Shortcuts Settings - Line break: - Set BR =
- Bullet sign: - Set BULLET = • - Vertical bar / pipe symbol: - Set VBAR = | - Line break and bullet with different levels of indentation: - Set BB =
• - Set BB2 =
  • - Set BB3 =
    • - Set BB4 =
      • - **_Hint:_** Above shortcuts are useful in TWiki tables where you cannot use newlines - Graphics used in TWiki documentation - view all images in %ICONTOPIC%. _(There are various ways to set up common icons as text variables. This is simply one quick approach.)_: - Set H = HELP - Set I = IDEA! - Set M = MOVED TO... - Set N = NEW - Set P = REFACTOR - Set Q = QUESTION? - Set S = PICK - Set T = TIP - Set U = UPDATED - Set X = ALERT! - Set Y = DONE - Colored text: (see more [[StandardColors]])
You type: %RED% red text %ENDCOLOR% and %GREEN% green text %ENDCOLOR%
You get: %RED% red text %ENDCOLOR% and %GREEN% green text %ENDCOLOR%
- **_Note:_** `%%` text must end with `%ENDCOLOR%`. If you want to switch from one color to another one you first need to end the active color with `%ENDCOLOR%`, e.g. write `%RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%`. - %YELLOW% **Set YELLOW = looks like this** %ENDCOLOR% - %ORANGE% **Set ORANGE = looks like this** %ENDCOLOR% - %RED% **Set RED = looks like this** %ENDCOLOR% - %PINK% **Set PINK = looks like this** %ENDCOLOR% - %PURPLE% **Set PURPLE = looks like this** %ENDCOLOR% - %TEAL% **Set TEAL = looks like this** %ENDCOLOR% - %NAVY% **Set NAVY = looks like this** %ENDCOLOR% - %BLUE% **Set BLUE = looks like this** %ENDCOLOR% - %AQUA% **Set AQUA = looks like this** %ENDCOLOR% - %LIME% **Set LIME = looks like this** %ENDCOLOR% - %GREEN% **Set GREEN = looks like this** %ENDCOLOR% - %OLIVE% **Set OLIVE = looks like this** %ENDCOLOR% - %MAROON% **Set MAROON = looks like this** %ENDCOLOR% - %BROWN% **Set BROWN = looks like this** %ENDCOLOR% - %BLACK% **Set BLACK = looks like this** %ENDCOLOR% - %GRAY% **Set GRAY = looks like this** %ENDCOLOR% - %SILVER% **Set SILVER = looks like this** %ENDCOLOR% - %WHITE% **Set WHITE = looks like this (with gray background)** %ENDCOLOR% - The following color settings are enclosed in verbatim tags to avoid incorrect nesting of XHTML tags: * Set YELLOW = * Set ORANGE = * Set RED = * Set PINK = * Set PURPLE = * Set TEAL = * Set NAVY = * Set BLUE = * Set AQUA = * Set LIME = * Set GREEN = * Set OLIVE = * Set MAROON = * Set BROWN = * Set BLACK = * Set GRAY = * Set SILVER = * Set WHITE = * Set ENDCOLOR = ## Miscellaneous Settings - Format of a [[NewWikiWord]] link: %BR% - default setting: - Set NEWLINKFORMAT = $text[?](http://www.dementia.org/twiki/edit/$web/$topic?topicparent=%WEB%.%TOPIC% Create this topic) - alternative setting: - #Set NEWLINKFORMAT = [$text](http://www.dementia.org/twiki/edit/$web/$topic?topicparent=%WEB%.%TOPIC% Create this topic) - [[PreviewBackground]] image: - Set PREVIEWBGIMAGE = ![preview2bg.gif](http://www.dementia.org/twiki//view/TWiki/PreviewBackground/preview2bg.gif) - User-friendly synonyms for MAINWEB and TWIKIWEB - Set USERSWEB = Main - Set SYSTEMWEB = TWiki - Set DOCWEB = TWiki ## Access Control Settings - Users or groups allowed to change or rename this %TOPIC% topic: - Set ALLOWTOPICCHANGE = [[TWikiAdminGroup]] - By default, only admins can create webs in the root - Set ALLOWROOTCHANGE = [[TWikiAdminGroup]] ## 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**
Example (as a nested bullet item, indented 6 spaces): - 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 `%WEBBGCOLOR%` . - %X% The sequential order of the preference settings is significant. Define preferences that use other preferences FIRST. For example, set **WEBCOPYRIGHT** before **WIKIWEBMASTER** since the copyright notice uses the TWiki administrator e-mail address. - %X% In order to protect your custom variables from being overwritten when upgrading the [[TWiki.%TOPIC%|TWiki/TOPIC]] topic, it is recommended that custom variables are defined in [[Main.%TOPIC%|Main/TOPIC]]. ## Related Topics - [[WebPreferences]] has preferences of the %WEB% web. - [[TWikiUsers]] has a list of user topics. User topics can have optional user preferences. - [[TWikiVariables]] has a list of common `%VARIABLES%`. - [[TWikiAccessControl]] explains how to restrict access by users or groups. - TWiki:Plugins.PreferencesPlugin makes editing preferences a snap. **_Note_**: Can't edit? [[View raw topic|%WEB%/%TOPIC%?raw=on]]