# <a name="%WIKITOOLNAME% Site-Level Prefer"></a><a name=" %WIKITOOLNAME% Site-Level Prefe"></a> %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 [[WebPreferences]] in each web), and on the **_user level_** (create preferences in your user account topic in the Main web, ex: Main.admin).
+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 [[WebPreferences]] in each web), **_topic level_** (the topic being rendered), and on the **_user level_** (create preferences in your user account topic in the Main web, ex: Main.admin).
- %X% **NOTE:** You can lock individual settings at the site or web levels using User & Group Access Control - see section below.
<div>
<ul>
- <li><a href="#Web Preferences"> Web Preferences</a></li>
- <li><a href="#User Settings"> User Settings</a></li>
- <li><a href="#TWiki Platform Settings"> TWiki Platform Settings</a></li>
- <li><a href="#Email and Proxy Server Settings"> Email and Proxy Server Settings</a><ul>
+ <li><a href="#Default Web Preferences"> Default Web Preferences</a></li>
+ <li><a href="#Default User Settings"> Default User Settings</a></li>
+ <li><a href="#TWiki Platform Settings"> TWiki Platform Settings</a><ul>
+ <li><a href="#Search Settings"> Search Settings</a></li>
+ <li><a href="#Email and Proxy Server Settings"> Email and Proxy Server Settings</a></li>
<li><a href="#Email Link Settings"> Email Link Settings</a></li>
+ <li><a href="#HTTP-EQUIV Settings"> HTTP-EQUIV Settings</a></li>
</ul>
</li>
<li><a href="#Plugins Settings"> Plugins Settings</a></li>
- <li><a href="#HTTP-EQUIV Settings"> HTTP-EQUIV Settings</a></li>
<li><a href="#Miscellaneous Settings"> Miscellaneous Settings</a></li>
<li><a href="#Access Control Settings"> Access Control Settings</a></li>
+ <li><a href="#Preferences Control Settings"> Preferences Control Settings</a></li>
<li><a href="#Creating New Preference Variable"> Creating New Preference Variables</a></li>
<li><a href="#Related Topics"> Related Topics</a></li>
</ul>
</div>
-## <a name="Web Preferences"></a> Web Preferences
+## <a name="Default Web Preferences"></a> Default Web Preferences
%X% **NOTE:** They are typically redefined in individual WebPreferences topics
- Set WEBBGCOLOR = #C0C0C0
- Copyright notice:
- - Set WEBCOPYRIGHT = <font>Copyright © 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%? [Send](mailto:?subject=%WIKITOOLNAME% Feedback on %WEB%.%TOPIC%) feedback. </font>
+ - Set WEBCOPYRIGHT = <font>Copyright © 1999-2010 by the contributing authors. \\nAll material on this collaboration platform is the property of the contributing authors. <br /> \\nIdeas, requests, problems regarding %WIKITOOLNAME%? [Send feedback](mailto:?subject=%WIKITOOLNAME% Feedback on %WEB%.%TOPIC%). </font>
+
+- Simplified Copyright notice for the [[WebRss]] feed (don't use any special characters or xml tags
+ - Set WEBRSSCOPYRIGHT = Copyright 2010 by contributing authors
- Exclude web from a `web="all"` search: (Set to `on` for hidden webs; is overwritten by web preferences)
- Set NOSEARCHALL =
- Set NOAUTOLINK =
- **_Note:_** Use the `[[...][...]]` syntax to link topics in case you disabled WikiWord linking. The `<noautolink> ... </noautolink>` syntax can be used to prevents links within a block of text.
-## <a name="User Settings"></a> User Settings
+- Warn if `%INCLUDE{}%` of topic fails: Fail silently (if empty or `off`); output "Warning: Can't INCLUDE Topic, topic not found" (if set to `on`); else, output specific text (use `$topic` for topic). You can override this setting by web preferences and by a `warn="..."` parameter in `%INCLUDE{}%` :
+ - Set INCLUDEWARNING = %RED% **_Note:_** %ENDCOLOR% Included topic [[$topic|Main/Topic]] does not exist yet
+
+## <a name="Default User Settings"></a> Default User Settings
%X% **NOTE:** They are typically redefined in topics of individual [[TWikiUsers]]
+- 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 WikiName, $wikiusername for Main.WikiName, $topic for the topic name, and $web for the web name
+ - Set LINKTOOLTIPINFO = on
+ - #Set LINKTOOLTIPINFO = $username - $date - $rev: $summary
+
- Horizontal size of text edit box: (can be overwritten by user preferences)
- Set EDITBOXWIDTH = 70
- %H% **NOTE:** Keyword <code>**$name**</code> gets expanded to filename; <code>**$comment**</code> to comment; <code>**$size**</code> to <code>**width="..." height="..."**</code> attribute of <code>**img**</code> tag; <code>**\\t**</code> to tab (3 spaces for bullets).
* Set ATTACHEDIMAGEFORMAT = \t* $comment: <br />
- <img src="%ATTACHURLPATH%/$name" alt="$name" $size />
+ <img src="%ATTACHURLPATH%/$name" alt="$comment" $size />
## <a name="TWiki Platform Settings"></a> TWiki Platform Settings
- TWiki platform name:
- - Set WIKITOOLNAME = TWiki
+ - Set WIKITOOLNAME = TWikibeta
- Image, URL and alternate tooltip text of TWiki logo: (can be overwritten by web preferences)
- Set WIKILOGOIMG = 
- Skin overriding the default TWiki templates: (can be overwritten by [[WebPreferences]] and user preferences)
- Set SKIN =
-## <a name="Email and Proxy Server Settings"></a> Email and Proxy Server Settings
+- Broadcast message for skins supporting a %BROADCASTMESSAGE% at the top of the page: (IMPORTANT: Set to empty message if not used; #Comment out unused messages)
+ - Set BROADCASTMESSAGE =
+ - #Set BROADCASTMESSAGE = <table border="0" cellpadding="3" cellspacing="0" width="100%">
+ <tr>
+ <td bgcolor="yellow"><font color="red"><strong>NOTE:</strong></font><font size="-1"> 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 %WIKITOOLNAME% maintenance. </font></td>
+ </tr>
+</table>
+
+- Maximum size of [[FileAttachments]] in KB, 0 for no limit:
+ - Set ATTACHFILESIZELIMIT = 10000
+
+### <a name="Search Settings"></a> Search Settings
+
+- Default type for search, one of: keyword (for search engine like syntax), regex (for [[RegularExpression]] search), or literal (for verbatim search)
+ - Set SEARCHDEFAULTTTYPE = keyword
+- Default for `%SEARCH{}%` variable, 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
+
+### <a name="Email and Proxy Server Settings"></a> Email and Proxy Server Settings
- TWiki webmaster email address:
- Set WIKIWEBMASTER = <webmaster@your.company>
+- TWiki webmaster name (first name and last name, e.g. `Fred Smith`):
+ - Set WIKIWEBMASTERNAME = TWiki Administrator
+
- Mail host for outgoing mail. This is used for [[WebChangesAlert]] if Perl module <code>**Net::SMTP**</code> is installed. If not, or if `SMTPMAILHOST` is empty, the external sendmail program is used instead (defined by <code>**$mailProgram**</code> in <code>**TWiki.cfg**</code>). Examples: <code>**mail.your.company**</code> or <code>**localhost**</code>
- Set SMTPMAILHOST = mail
- URL for current topic
- Set TOPICURL = <http://www.dementia.org/twiki//view/%WEB%/WebHome>
-## <a name="Plugins Settings"></a> 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 TWiki web for the plugin topics. Specify plugins as a comma separated list of topics.
- - Set INSTALLEDPLUGINS = [[DefaultPlugin]]
- - Set DISABLEDPLUGINS = [[EmptyPlugin]]
- - Currently activated plugins: [[SpreadSheetPlugin]], [[CommentPlugin]], [[EditTablePlugin]], [[InterwikiPlugin]], [[PreferencesPlugin]], [[SlideShowPlugin]], [[SmiliesPlugin]], [[TablePlugin]], [[TwistyPlugin]]
- - %T% **NOTE:** You can enable/disable all plugins with the <code>**$disableAllPlugins**</code> flag in the <code>**lib/TWiki.cfg**</code> file.
+### <a name="HTTP-EQUIV Settings"></a> HTTP-EQUIV Settings
-## <a name="HTTP-EQUIV Settings"></a> HTTP-EQUIV Settings
+- %T% **NOTE:** Changing cache behaviour with these settings should not be necessary and may cause cache-related problems (e.g. TWiki:Codev/BackFromPreviewLosesText or TWiki:Codev/RefreshEditPage). These settings do not affect proxy caches.
- <code>**http-equiv**</code> meta tags for <code>**view**</code>, <code>**rdiff**</code>, <code>**attach**</code>, <code>**search\***</code> scripts:
* Set HTTP_EQUIV_ON_VIEW =
-- <code>**http-equiv**</code> meta tags for <code>**edit**</code> script. Example, to expire immediately: <br />`Set HTTP_EQUIV_ON_EDIT = <meta http-equiv="Expires" content="%GMTIME{"$day $month $year $hour:$min:$sec"}% GMT">`
+- <code>**http-equiv**</code> meta tags for <code>**edit**</code> script:
* Set HTTP_EQUIV_ON_EDIT =
* Set HTTP_EQUIV_ON_PREVIEW =
+## <a name="Plugins Settings"></a> 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 TWiki web for the plugin topics. Specify plugins as a comma separated list of topics.
+ - Set INSTALLEDPLUGINS = [[DefaultPlugin]], [[SpreadSheetPlugin]]
+ - Set DISABLEDPLUGINS = [[EmptyPlugin]]
+ - Currently activated plugins: [[SpreadSheetPlugin]], [[CommentPlugin]], [[EditTablePlugin]], [[InterwikiPlugin]], [[PreferencesPlugin]], [[SlideShowPlugin]], [[SmiliesPlugin]], [[TablePlugin]], [[TwistyPlugin]]
+ - %T% **NOTE:** You can enable/disable all plugins with the <code>**$disableAllPlugins**</code> flag in the <code>**lib/TWiki.cfg**</code> file.
+
## <a name="Miscellaneous Settings"></a> Miscellaneous Settings
- Line break:
- Bullet sign:
- Set BULLET = •
+- Line break and bullet with different levels of indentation:
+ - Set BB = <br />•
+ - Set BB2 = <br /> •
+ - Set BB3 = <br /> •
+ - Set BB4 = <br /> •
+
- Colored text: (see more [[StandardColors]]) <table border="1" cellpadding="0" cellspacing="0">
<tr>
<td> You type: </td>
<td> %RED% red text %ENDCOLOR% and %GREEN% green text %ENDCOLOR% </td>
</tr>
</table>
- - **_Note:_** `%<color>%` 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%`.
- - Set YELLOW = <font>
- - **YELLOW looks like this**</font>
-- Set ORANGE = <font>
- - **ORANGE looks like this**</font>
-
-- Set RED = <font>
- - **RED looks like this**</font>
-
-- Set PINK = <font>
- - **PINK looks like this**</font>
-
-- Set PURPLE = <font>
- - **PURPLE looks like this**</font>
-
-- Set TEAL = <font>
- - **TEAL looks like this**</font>
-
-- Set NAVY = <font>
- - **NAVY looks like this**</font>
-
-- Set BLUE = <font>
- - **BLUE looks like this**</font>
-
-- Set AQUA = <font>
- - **AQUA looks like this**</font>
-
-- Set LIME = <font>
- - **LIME looks like this**</font>
-
-- Set GREEN = <font>
- - **GREEN looks like this**</font>
-
-- Set OLIVE = <font>
- - **OLIVE looks like this**</font>
-
-- Set MAROON = <font>
- - **MAROON looks like this**</font>
-
-- Set BLACK = <font>
- - **BLACK looks like this**</font>
-
-- Set GRAY = <font>
- - **GRAY looks like this**</font>
-
-- Set SILVER = <font>
- - **SILVER looks like this**</font>
-
-- Set WHITE = <font>
- - **WHITE looks like this**</font>
-
-- And finally:<font> </font>
-- Set ENDCOLOR =
- - To finish colored text
+ - **_Note:_** `%<color>%` 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%
+ - %BLACK% **Set BLACK = looks like this** %ENDCOLOR%
+ - %GRAY% **Set GRAY = looks like this** %ENDCOLOR%
+ - %SILVER% **Set SILVER = looks like this** %ENDCOLOR%
+ - <span>%WHITE% **Set WHITE = looks like this (with gray background)** %ENDCOLOR%</span>
+ - The following color settings are enclosed in verbatim tags to avoid incorrect nesting of XHTML tags:
+
+ * Set YELLOW = <font color="#ffff00">
+ * Set ORANGE = <font color="#ff6600">
+ * Set RED = <font color="#ff0000">
+ * Set PINK = <font color="#ff00ff">
+ * Set PURPLE = <font color="#800080">
+ * Set TEAL = <font color="#008080">
+ * Set NAVY = <font color="#000080">
+ * Set BLUE = <font color="#0000ff">
+ * Set AQUA = <font color="#00ffff">
+ * Set LIME = <font color="#00ff00">
+ * Set GREEN = <font color="#008000">
+ * Set OLIVE = <font color="#808000">
+ * Set MAROON = <font color="#800000">
+ * Set BLACK = <font color="#000000">
+ * Set GRAY = <font color="#808080">
+ * Set SILVER = <font color="#c0c0c0">
+ * Set WHITE = <font color="#ffffff">
+ * Set ENDCOLOR = </font>
<a name="DocGraphics"></a>
- Users or groups allowed to change or rename this %TOPIC% topic: (ex: [[TWikiAdminGroup]])
- Set ALLOWTOPICCHANGE =
- - Set ALLOWTOPICRENAME =
+ - Set ALLOWTOPICRENAME = [[TWikiAdminGroup]]
- Users or groups allowed to [[create new webs|TWiki/ManagingWebs]]: (ex: [[TWikiAdminGroup]])
- Set ALLOWWEBMANAGE = [[TWikiAdminGroup]]
+## <a name="Preferences Control Settings"></a> Preferences Control Settings
+
+- Allow topic level preferences, on or off: If set to `on`, topic preferences will be read, and will override any web- or site-level preferences not set as `FINALPREFERENCES`. By default, user preferences will override topic preferences.
+ - Set READTOPICPREFS = on
+
+- Topic level overrides user level preferences, on or off: If set to `on`, topic preferences will override user preferences. The user can in turn override this behavior by setting further `FINALPREFERENCES` in his or her user topic.
+ - Set TOPICOVERRIDESUSER = off
+
- Site-level preferences that are **not** allowed to be overridden by [[WebPreferences]] and user preferences:
- - Set FINALPREFERENCES = PREVIEWBGIMAGE, WIKITOOLNAME, WIKIWEBMASTER, SMTPMAILHOST , SMTPSENDERHOST, ALLOWWEBMANAGE
+ - Set FINALPREFERENCES = ATTACHFILESIZELIMIT, PREVIEWBGIMAGE, WIKITOOLNAME, WIKIWEBMASTER, SMTPMAILHOST, SMTPSENDERHOST, ALLOWWEBMANAGE, READTOPICPREFS, TOPICOVERRIDESUSER
## <a name="Creating New Preference Variable"></a> Creating New Preference Variables
git://git.openafs.org / openafs-wiki.git / blobdiff