-# <a name="%WIKITOOLNAME% Site-Level Prefer"></a> %WIKITOOLNAME% Site-Level Preferences
+# <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="#%WIKITOOLNAME% Site-Level Prefer">%WIKITOOLNAME% Site-Level Preferences</a><ul>
- <li><a href="#General Preferences"> General Preferences</a></li>
- <li><a href="#Email Settings"> Email Settings</a></li>
- <li><a href="#Plugins Settings"> Plugins Settings</a></li>
+ <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>
- <li><a href="#Miscellaneous Settings"> Miscellaneous Settings</a></li>
- <li><a href="#Access Control Settings"> Access 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>
</li>
+ <li><a href="#Skin Settings"> Skin Settings</a><ul>
+ <li><a href="#PatternSkin"> PatternSkin</a></li>
+ <li><a href="#DragonSkin"> DragonSkin</a></li>
+ </ul>
+ </li>
+ <li><a href="#Plugins Settings"> Plugins 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="Default Web Preferences"></a> Default Web Preferences
-## <a name="General Preferences"></a> General Preferences
-
-- List of %WIKITOOLNAME% webs - on the first line of the upper toolbar (to add a new web, see [[ManagingWebs]] and [[SiteMap]]):
- - Set WIKIWEBLIST = [[Main|Main/WebHome]] | [[TWiki|TWiki/WebHome]] | [[Know|Know/WebHome]] | [[Sandbox|Sandbox/WebHome]]
- - %T% **NOTE:** To automatically list all non-hidden webs in alphabetical order, use this variable instead: <br />Set WIKIWEBLIST =
+%X% **NOTE:** They are typically redefined in individual WebPreferences topics
- List of selected topics in a web - the second line of the upper toolbar (usually overwritten in individual [[WebPreferences]]):
- - Set WEBTOPICLIST = [[Home|Main/WebHome]] | [[Changes|Main/WebChanges]] | [[Index|Main/WebIndex]] | [[Search|Main/WebSearch]] | Go <input name="topic" size="16" type="text" />
+ - Set WEBTOPICLIST = [[Changes|Main/WebChanges]] | [[Index|Main/WebIndex]] | [[Search|Main/WebSearch]] | Go <input name="topic" size="16" type="text" />
+
+- Web specific background color: (is overwritten by web preferences)
+ - Set WEBBGCOLOR = #C0C0C0
- Copyright notice:
- - Set WEBCOPYRIGHT = <font>Copyright © 1999-2002 by the contributing authors. \\nAll material on this collaboration tool is the property of the contributing authors. <br /> \\nIdeas, requests, problems regarding %WIKITOOLNAME%? [Send](mailto:?subject=%WIKITOOLNAME% Feedback) 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 =
-- Web specific background color: (is overwritten by web preferences)
- - Set WEBBGCOLOR = #C0C0C0
+- Prevent automatic linking of [[WikiWords]] and acronyms (if set to `on`); link WikiWords (if empty); can be overwritten by web preferences:
+ - 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.
-- [[PreviewBackground]] image:
- - Set PREVIEWBGIMAGE = 
+- 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
-- Background color of non existing topic: ( default `cornsilk` or `#FFFFCE` )
- - Set NEWTOPICBGCOLOR = #FFFFCE
+## <a name="Default User Settings"></a> Default User Settings
-- Font color of non existing topic: ( default `#0000FF` )
- - Set NEWTOPICFONTCOLOR = #0000FF
+%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 = off
+ - #Set LINKTOOLTIPINFO = $username - $date - $rev: $summary
- 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 =
- %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 site name:
+ - Set WIKITOOLNAME = TWikibeta
+
+- Image, URL and alternate tooltip text of TWiki logo: (can be overwritten by web preferences)
+ - Set WIKILOGOIMG = 
+ - 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 [[SiteMap]]):
+ - Set WIKIWEBLIST = [[Main|Main/WebHome]] | [[TWiki|TWiki/WebHome]] | [[Sandbox|Sandbox/WebHome]]
+ - %T% **NOTE:** To automatically list all non-hidden webs in alphabetical order, use the `%WEBLIST{}%` variable instead: <br />
+
+- Maximum size of [[FileAttachments]] in KB, 0 for no limit:
+ - Set ATTACHFILESIZELIMIT = 10000
+
+- 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>
+
+### <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 Settings"></a> Email Settings
+### <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
- Mail domain sending mail. SMTP requires that you identify the TWiki server sending mail. If not set, <code>**Net::SMTP**</code> will guess it for you. Ex: <code>**twiki.your.company**</code>
- Set SMTPSENDERHOST =
-## <a name="Plugins Settings"></a> Plugins Settings
+- Proxy Server. Some environments require outbound HTTP traffic to go through a proxy server. Set the host in PROXYHOST (example: <code>**proxy.your.company**</code>), and the port number in PROXYPORT (example: <code>**8080**</code>). No proxy is used if PROXYHOST or PROXYPORT is empty.
+ - Set PROXYHOST =
+ - Set PROXYPORT =
-- [[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="Email Link Settings"></a> Email Link Settings
+
+- 'Mail this topic' mailto: link - can be included in topics, templates or skins
+ - Set MAILTHISTOPIC = [%MAILTHISTOPICTEXT%](mailto:?subject=WebHome&body=%TOPICURL%)
+
+- 'Mail this topic' link text
+ - Set MAILTHISTOPICTEXT = Send a link to this page
+
+- URL for current topic
+ - Set TOPICURL = <http://www.dementia.org/twiki//view/%WEB%/WebHome>
-## <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 =
+ * #Set HTTP_EQUIV_ON_VIEW =
+ * Set HTTP_EQUIV_ON_VIEW = <link rel="alternate" type="application/rss+xml" title="RSS Feed" href="%SCRIPTURL%/view%SCRIPTSUFFIX%/%WEB%/WebRss?skin=rss&contenttype=text/xml" />
-- <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="Miscellaneous Settings"></a> Miscellaneous Settings
+## <a name="Skin Settings"></a> Skin Settings
-- Graphics used in TWiki documentation - view all images in [[TWikiDocGraphics]]. _(There are various ways to set up common icons as text variables. This is simply one quick approach.)_:
- - Set H = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/help.gif" width="16" height="16" alt="HELP" />
- - Set I = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/tip.gif" width="16" height="16" alt="IDEA!" />
- - Set M = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/arrowright.gif" width="16" height="16" alt="MOVED TO..." />
- - Set N = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/new.gif" width="28" height="8" alt="NEW" />
- - Set P = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/pencil.gif" width="16" height="16" alt="REFACTOR" />
- - Set Q = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/help.gif" width="16" height="16" alt="QUESTION?" />
- - Set S = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/starred.gif" width="16" height="16" alt="PICK" />
- - Set T = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/tip.gif" width="16" height="16" alt="TIP" />
- - Set U = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/updated.gif" width="56" height="8" alt="UPDATED" />
- - Set X = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/warning.gif" width="16" height="16" alt="ALERT!" />
- - Set Y = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/choice-yes.gif" width="16" height="16" alt="DONE" />
- - Set TLS = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/8831.gif" width="88" height="31" alt="TWiki ID button" />
+- Skin overriding the default TWiki templates: (can be overwritten by [[WebPreferences]] and user preferences)
+ - #Set SKIN = pattern
-- Colored text: (see more [[StandardColors]]) <table border="1" cellpadding="0" cellspacing="0">
- <tr>
- <td> You type: </td>
- <td><code>%RED% red text %ENDCOLOR% and %GREEN% green text %ENDCOLOR%</code></td>
- </tr>
- <tr>
- <td> You get: </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 RED = <font>
- - **RED looks like this**</font>
+- **_Note:_** See [[TWikiSkinBrowser]] for currently installed skins
-- Set PINK = <font>
- - **PINK looks like this**</font>
+### <a name="PatternSkin"></a> [[PatternSkin]]
-- Set PURPLE = <font>
- - **PURPLE looks like this**</font>
+- Using attachments for styles
+ - #Set TWIKILAYOUTURL = <http://www.dementia.org/twiki//view/TWiki/PatternSkin/layout.css>
+ - #Set TWIKISTYLEURL = <http://www.dementia.org/twiki//view/TWiki/PatternSkin/style.css>
-- Set TEAL = <font>
- - **TEAL looks like this**</font>
+- Using topics to define styles - these settings will override attachment style settings above -
+ - Default TWiki CSS styling topics where layout and style are are defined:
+ - #Set TWIKILAYOUTTOPIC = [[TWikiLayout]]
+ - #Set TWIKISTYLETOPIC = [[TWikiStyle]]
+ - CSS styling topics to be defined in local webs or in user topics (these can complement or override default TWiki style topics):
+ - Set LAYOUTTOPIC =
+ - Set STYLETOPIC =
+ - Use the CSS TOPIC setting above to build the URLS used in the templates
+ - #Set TWIKILAYOUTURL = ..//%TWIKILAYOUTTOPIC%?skin=text&contenttype=text/css
+ - #Set TWIKISTYLEURL = ..//%TWIKISTYLETOPIC%?skin=text&contenttype=text/css
+ - #Set USERLAYOUTURL = ..//%USERLAYOUTTOPIC%?skin=text&contenttype=text/css
+ - #Set USERSTYLEURL = ..//%USERSTYLETOPIC%?skin=text&contenttype=text/css
-- Set NAVY = <font>
- - **NAVY looks like this**</font>
+### <a name="DragonSkin"></a> [[DragonSkin]]
-- Set BLUE = <font>
- - **BLUE looks like this**</font>
+- Theme: (gray, monochrome, tabstyle)
+ - Set DS\_THEME = gray
+- Quicklinks headings:
+ - Set DS\_QUICKLINKSHEADING =
+- Quicklinks submenu:
+ - Set DS\_QUICKLINKS =
-- Set AQUA = <font>
- - **AQUA looks like this**</font>
+## <a name="Plugins Settings"></a> Plugins Settings
-- Set LIME = <font>
- - **LIME looks like this**</font>
+- [[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
-- Set GREEN = <font>
- - **GREEN looks like this**</font>
+- Line break:
+ - Set BR = <br />
-- Set OLIVE = <font>
- - **OLIVE looks like this**</font>
+- Bullet sign:
+ - Set BULLET = •
-- Set MAROON = <font>
- - **MAROON looks like this**</font>
+- Line break and bullet with different levels of indentation:
+ - Set BB = <br />•
+ - Set BB2 = <br /> •
+ - Set BB3 = <br /> •
+ - Set BB4 = <br /> •
-- Set BLACK = <font>
- - **BLACK looks like this**</font>
+- Colored text: (see more [[StandardColors]]) <table border="1" cellpadding="0" cellspacing="0">
+ <tr>
+ <td> You type: </td>
+ <td><code>%RED% red text %ENDCOLOR% and %GREEN% green text %ENDCOLOR%</code></td>
+ </tr>
+ <tr>
+ <td> You get: </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%`.
+ - %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%
+ - <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 BROWN = <font color="#996633">
+ * 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>
-- Set GRAY = <font>
- - **GRAY looks like this**</font>
+- Graphics used in TWiki documentation - view all images in [[TWikiDocGraphics]]. _(There are various ways to set up common icons as text variables. This is simply one quick approach.)_:
+ - Set H = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/help.gif" width="16" height="16" alt="HELP" />
+ - Set I = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/tip.gif" width="16" height="16" alt="IDEA!" />
+ - Set M = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/arrowright.gif" width="16" height="16" alt="MOVED TO..." />
+ - Set N = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/new.gif" width="28" height="8" alt="NEW" />
+ - Set P = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/pencil.gif" width="16" height="16" alt="REFACTOR" />
+ - Set Q = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/help.gif" width="16" height="16" alt="QUESTION?" />
+ - Set S = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/starred.gif" width="16" height="16" alt="PICK" />
+ - Set T = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/tip.gif" width="16" height="16" alt="TIP" />
+ - Set U = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/updated.gif" width="56" height="8" alt="UPDATED" />
+ - Set X = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/warning.gif" width="16" height="16" alt="ALERT!" />
+ - Set Y = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/choice-yes.gif" width="16" height="16" alt="DONE" />
-- Set SILVER = <font>
- - **SILVER looks like this**</font>
+- Background color of non existing topic: ( default `cornsilk` or `#FFFFCE` )
+ - Set NEWTOPICBGCOLOR = #FFFFCE
-- Set WHITE = <font>
- - **WHITE looks like this**</font>
+- Font color of non existing topic: ( default `#0000FF` )
+ - Set NEWTOPICFONTCOLOR = #0000FF
-- And finally:
-- Set ENDCOLOR =
- - To finish colored text
+- [[PreviewBackground]] image:
+ - Set PREVIEWBGIMAGE = 
## <a name="Access Control Settings"></a> Access Control Settings
- 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, WIKIWEBMASTER, SMTPMAILHOST , SMTPSENDERHOST, ALLOWWEBMANAGE
+ - Set FINALPREFERENCES = ATTACHFILESIZELIMIT, PREVIEWBGIMAGE, WIKITOOLNAME, WIKIWEBMASTER, SMTPMAILHOST, SMTPSENDERHOST, ALLOWWEBMANAGE, READTOPICPREFS, TOPICOVERRIDESUSER, BASICSTYLETOPIC
## <a name="Creating New Preference Variable"></a> Creating New Preference Variables
- [[WebPreferences]] has preferences of the %WIKITOOLNAME%.%WEB% web.
- [[TWikiUsers]] has a list of user topics. User topics can have optional user preferences.
-- [[TWikiVariables]] has a list of common `%VARIABLES%` .
+- [[TWikiVariables]] has a list of common `%VARIABLES%`.
- [[TWikiAccessControl]] explains how to restrict access by users or groups.
+
+**_Note_**: Can't edit? [View raw topic](http://www.dementia.org/twiki//view/%WEB%/%TOPIC%?raw=on)
git://git.openafs.org / openafs-wiki.git / blobdiff