~kosova/+junk/tuxfamily-twiki

%META:TOPICINFO{author="ProjectContributor" date="1231502400" format="1.1" version="1"}%

---+!! <nop>%WIKITOOLNAME% Site-Level Preferences

 

This topic defines *site-level* settings that apply to all users and webs on this site.

 

<div class="foswikiNotification">

*%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 [[%LOCALSITEPREFS%]] (this topic is pointed to by {LocalSitePreferences}, which is set by the admin in the [[%SCRIPTURLPATH{"configure"}%][configure]] interface). Settings in [[%LOCALSITEPREFS%]] will override settings in this topic, and should be used for defining custom settings.

 

[[Macros#SettingPrefs][Read more]] on how to set preferences.

</div>

 

%TOC%

 

#DefaultWebPreferences

---++ Default Web Preferences

 

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

 

   * List of selected topics in a web (used in menus)

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

 

   * [[http://en.wikipedia.org/wiki/Favicon][favicon]]: Attach a =favicon.ico= to a web's WebPreferences or add a =FAVICON= setting to WebPreferences

      * Set FAVICON = %PUBURLPATH%/%SYSTEMWEB%/ProjectLogos/favicon.ico

 

   * Image, URL and alternate tooltip text of web's logo.

      * Set WEBLOGOIMG = %WIKILOGOIMG%

      * Set WEBLOGOURL = %WIKILOGOURL%

      * Set WEBLOGOALT = %WIKILOGOALT%

 

   * List this web in the %SYSTEMWEB%.SiteMap:

      * If yes, set SITEMAPLIST to =on=, do not set NOSEARCHALL, and add the "what" and "use to..." description for the site map. Make sure to list only links that include the name of the web, e.g. <nop>%WEB%.Topic links.

      * Set SITEMAPLIST = on

      * Set SITEMAPWHAT = Describe what this web does.

      * Set SITEMAPUSETO = ...to do something.

 

   * Copyright notice:

      * Set WEBCOPYRIGHT = <span class="foswikiRight"> <a href="http://foswiki.org/"><img src="%PUBURLPATH%/%SYSTEMWEB%/ProjectLogos/foswiki-badge.gif" alt="%MAKETEXT{"This site is powered by Foswiki"}%" title="%MAKETEXT{"This site is powered by Foswiki"}%" border="0" /></a></span>%MAKETEXT{"Copyright &&copy; by the contributing authors. All material on this collaboration platform is the property of the contributing authors." args="1999-%GMTIME{$year}%"}% <br /> %MAKETEXT{"Ideas, requests, problems regarding [_1]? <a href='[_2]'>Send feedback</a>" args="<nop>%WIKITOOLNAME%,mailto:%WIKIWEBMASTER%?subject=%WIKITOOLNAME%%20Feedback%20on%20%BASEWEB%.%BASETOPIC%"}%

 

   * Simplified Copyright notice for the WebRss feed (don't use any special characters, html tags, entities, wiki markup or WikiWords)

      * Set WEBRSSCOPYRIGHT = Copyright %GMTIME{"$year"}% by contributing authors

 

   * Exclude web from a =web="all"= search: (Set to =on= for hidden webs; is overwritten by web preferences) *Note* it is much better to use [[AccessControl][AccessControls]] in individual webs to control who can and can't view the contents of a web. NOSEARCHALL is retained for compatibility, but you should avoid using it.

      * Set NOSEARCHALL =

   * Prevent automatic linking of [[%SYSTEMWEB%.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.

   * If you use non !WikiWords for topic names (for example "Expenses" or "Mighty1") and if you use bracket notation to link to those topics, it is useful to *turn of all warnings* (like: "WARNING: This topic name is not recommended because it will not be linked automatically") and checkboxes ("Allow non !WikiWord for the new topic name"). Can be overwritten by web preferences. Set to =on= to activate:

      * Set HIDE_NON_WIKI_WORD_WARNINGS =

 

   * Warn if =%<nop>INCLUDE{}%= of topic fails: Fail silently if empty or =off=. Output warning message (defined in templates/oopsalerts.tmpl) if set to =on=. Otherwise output specific text (use =$topic= for topic). You can override this in web preferences, or by using a =warn="..."= parameter with =%<nop>INCLUDE{}%= :

      * Set INCLUDEWARNING = on

 

   * Generated Table of Contents (TOC) settings

      * The first header level to appear in the TOC:

         * Set TOC_MIN_DEPTH =

            * If not set: =1=

            * Possible values: =1= to =6=

      * The last header level to appear in the TOC:

         * Set TOC_MAX_DEPTH =

            * If not set: =6=

            * Possible values: =1= to =6=

            * Can be overridden by =depth= parameter of [[%SYSTEMWEB%.VarTOC][TOC]]

      * The default TOC title:

         * Set TOC_TITLE =

            * If not set: nothing

            * Possible values: any string, for example =On this page:=

            * Can be overridden by =title= parameter of [[%SYSTEMWEB%.VarTOC][TOC]]

      * Do not show a TOC if the topic it contains is included in another topic:

         * Set TOC_HIDE_IF_INCLUDED =

            * If not set: included TOC is shown

            * Possible values: =on= or nothing

 

---++ Default User Settings

 

%X% *NOTE:* They are typically redefined in topics of individual %USERSWEB%.WikiUsers

 

   * Show tool-tip topic info on mouse-over of WikiWord links. Setting can be on, off, or customized. An empty setting or off setting disables the tool-tips (for better performance). The setting can contain $summary to show the topic summary, $date for the last change date, $rev for the revision, $username for the login name of the last editor, $wikiname for the <nop>WikiName, $wikiusername for <nop>%USERSWEB%.WikiName, $topic for the topic name, and $web for the web name

      * Set LINKTOOLTIPINFO = off

      * #Set LINKTOOLTIPINFO = $username - $date - r$rev: $summary

         * This is exactly equivalent to:

      * #Set LINKTOOLTIPINFO = on

 

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

 

   * Style of text edit box. Set to =width: 99%= for full window width (default; this will override 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 *Force New Revision* (ForceNewRevision) check box in preview. Check box is initially checked if =Set FORCENEWREVISIONCHECKBOX = checked="checked"=, or unchecked if empty: (can be overwritten by user preferences)

      * Set FORCENEWREVISIONCHECKBOX =

 

   * 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).

<!-- verbatim tag required to prevent error in Apache log; does not suppress Set -->

<verbatim>

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

</verbatim>

 

   * 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 and ==\n== to linefeed (3 spaces for bullets).

<verbatim>

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

</verbatim>

 

---++ Platform Settings

 

   * Site name:

      * Set WIKITOOLNAME = Foswiki

 

   * Image, URL and alternate tooltip text of the logo *for this installation*: you should change these settings for your site, or they can be overwridden in !WebPreferences for individual webs by defining these settings there.

      * Set WIKILOGOIMG = %PUBURL%/%SYSTEMWEB%/ProjectLogos/foswiki-logo.png

      * Set WIKILOGOURL = %SCRIPTURL{"view"}%/%USERSWEB%/%HOMETOPIC%

      * Set WIKILOGOALT = Powered by Foswiki, The Free and Open Source Wiki

 

   * Home page of this site

      * Set WIKIHOMEURL = %SCRIPTURLPATH{"view"}%

 

   * List of <nop>%WIKITOOLNAME% webs - on the first line of the upper toolbar (to add a new web, see ManagingWebs and %SYSTEMWEB%.SiteMap):

      * Set WIKIWEBLIST = [[%USERSWEB%.%HOMETOPIC%][%USERSWEB%]] %SEP% [[%SYSTEMWEB%.%HOMETOPIC%][%SYSTEMWEB%]] %SEP% [[Sandbox.%HOMETOPIC%][Sandbox]]

      * %T% *NOTE:* To automatically list all non-hidden webs in alphabetical order, use the =%<nop>WEBLIST{}%= macro instead: <br />

        %WEBLIST{"[[$name.%HOMETOPIC%][$name]]" separator=" | "}%

 

   * Maximum size of %SYSTEMWEB%.FileAttachments in KB, 0 for no limit:

      * Set ATTACHFILESIZELIMIT = 10000

 

   * Broadcast message for skins supporting a %<nop>BROADCASTMESSAGE% at the top of the page: (IMPORTANT: Set to empty message if not used; #Comment out unused messages)

      * Set BROADCASTMESSAGE =

      * #Set BROADCASTMESSAGE = *NOTE:* Edit and Attach will be disabled today between 05:00 PM and 06:00 PM PDT (00:00 to 01:00 GMT) for a scheduled <nop>%WIKITOOLNAME% maintenance.

 

   * Users or groups allowed to [[%SYSTEMWEB%.ManagingWebs][create new top-level webs]]: (ex: %USERSWEB%.WebCreatorsGroup). If set to nothing, only administrators will be able to do this.

      * Set ALLOWROOTCHANGE = %USERSWEB%.AdminGroup

 

---+++ Search Settings

 

   * Default type for search bin script, one of: keyword (for search engine like syntax), regex (for RegularExpression search), or literal (for verbatim search). It does not influence the default for the WebSearch

      * Set SEARCHDEFAULTTTYPE = keyword

   * Default for =%<nop>SEARCH{}%= macro, one of: keyword, regex, or literal

      * Set SEARCHVARDEFAULTTYPE = literal

   * Stop words, e.g., common words and characters to exclude from a keyword search:

      * Set SEARCHSTOPWORDS = a, all, am, an, and, any, as, at, b, be, by, c, d, e, for, from, g, h, how, i, i'm, i.e., in, is, isn't, it, it's, its, j, k, l, m, n, o, of, on, or, p, q, r, s, t, that, that's, the, this, to, u, v, w, was, wasn't, what, what's, when, where, who, who's, will, with, x, y, z

 

---+++ E-mail Settings

 

   * 'Mail this topic' mailto: link - can be included in topics, templates or skins

      * Set MAILTHISTOPIC = <a href="mailto:?subject=%BASETOPIC%&amp;body=%TOPICURL%">%MAILTHISTOPICTEXT%</a>

 

   * 'Mail this topic' link text

      * Set MAILTHISTOPICTEXT = Send a link to this page

 

   * URL for current topic

      * Set TOPICURL = %SCRIPTURL{"view"}%/%WEB%/%BASETOPIC%

 

 

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

 

   * %T% *NOTE:* Changing cache behaviour with these settings should not be necessary and may cause cache-related problems. These settings do not affect proxy caches.

   * *NOTE:* The current values of these preferences are not displayed in view mode (values are <code>&lt;link&gt;</code>-tags).

 

   * ==http-equiv== meta tags for ==view==, ==rdiff==, ==attach==, ==search*== scripts:

      * #Set HTTP_EQUIV_ON_VIEW =

      * Set HTTP_EQUIV_ON_VIEW = <link rel="alternate" type="application/rss+xml" title="RSS Feed" href="%SCRIPTURLPATH{"view"}%/%WEB%/WebRss" />

 

   * ==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 templates: (can be overwritten by WebPreferences and user preferences)

      * Set SKIN = pattern

 

   * *Note:* See SkinBrowser for currently installed skins

 

---+++ PatternSkin

 

   * Global skin styles. To change the look of the site, point these variables to custom CSS attachments.

      * Set FOSWIKI_LAYOUT_URL = %PUBURLPATH%/%SYSTEMWEB%/PatternSkin/layout.css

      * Set FOSWIKI_STYLE_URL = %PUBURLPATH%/%SYSTEMWEB%/PatternSkin/style.css

      * Set FOSWIKI_COLORS_URL = %PUBURLPATH%/%SYSTEMWEB%/PatternSkin/colors.css

 

   * Themes that add upon the global skin styles. Choose from the Theme Browser at PatternSkin.

      * Set PATTERNSKIN_THEME = %PUBURLPATH%/%SYSTEMWEB%/PatternSkin/theme_foswiki_noframe.css

      * Set PATTERNSKIN_COLUMNS = %PUBURLPATH%/%SYSTEMWEB%/PatternSkin/column_left.css

 

   * Overriding styles that add upon the global and theme styles. Enabled by default but empty to prevent browsers from fetching %<nop>USERLAYOUTURL%-style URLs.

      * Set USERLAYOUTURL =

      * Set USERSTYLEURL =

      * Set USERCOLORSURL =

      * Set WEBHEADERART =

      * Set WEBHEADERBGCOLOR =

 

---+++ Skin icons

 

   * Topic containing the icon graphics library. Icons can easily be rendered with =%<nop>ICON{name}%=.

      * Set ICONTOPIC = %SYSTEMWEB%.DocumentGraphics

 

---+++ Legacy support

   * Support for legacy "EDITTOPIC", used to be hard-coded, now replaced by TMPL:P conditional instantiation

      * Set EDITURL = %SCRIPTURLPATH{"edit"}%/%WEB%/%TOPIC%?t=%GMTIME{"$epoch"}%

      * Set EDITTOPIC = <a href="%EDITURL%" title="Edit Topic - deprecated usage - please see release notes">Edit</a>

 

---++ Plugins Settings

 

   * You can enable/disable Plugins using the [[%SCRIPTURLPATH{"configure"}%][configure]] interface.

   * You can also disable installed plugins in individual webs/topics by defining the DISABLEDPLUGINS [[PreferenceSettings][preference setting]] to be a list of plugins to disable e.g.

      * <nop>Set DISABLEDPLUGINS = SpreadSheetPlugin,EditTablePlugin

      * Currently, %<nop>DISABLEDPLUGINS% is set to "%DISABLEDPLUGINS%"

   * Currently activated Plugins: %ACTIVATEDPLUGINS%

 

   * %T% *NOTE:* You can enable/disable Plugins by passing a comma-separated list of Plugin names in the =debugenableplugins= url parameter; for example, %SCRIPTURL{"view"}%/%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 macro is no longer supported. You can set the Plugins execution order using the [[%SCRIPTURLPATH{"configure"}%][configure]] interface.

 

#RenderingShortcuts

---++ Rendering Shortcuts Settings

 

   * Line break: Note that the setting has an intentional trailing space

      * Set BR = <br /> 

 

   * Bullet sign:

      * Set BULLET = &#8226;

 

   * Vertical bar / pipe symbol:

      * Set VBAR = &#124;

 

   * Vertical caret symbol:

      * Set CARET = &#94;

 

   * Line break and bullet with different levels of indentation:

      * Set BB = <br />&#8226;

      * Set BB2 = <br />&nbsp;&nbsp;&#8226;

      * Set BB3 = <br />&nbsp;&nbsp;&nbsp;&nbsp;&#8226;

      * Set BB4 = <br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&#8226;

 

   * *Hint:* Above shortcuts are useful in tables where you cannot use newlines

 

#DocGraphics

   * Macros for graphics used in documentation - view all images in %ICONTOPIC%: