-# <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).
<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="#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>
+ <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="#Email Link Settings"> Email Link 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="#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="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-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>
- 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="User Settings"></a> User Settings
-- Font color of non existing topic: ( default `#0000FF` )
- - Set NEWTOPICFONTCOLOR = #0000FF
+%X% **NOTE:** They are typically redefined in topics of individual [[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 =
* Set ATTACHEDIMAGEFORMAT = \t* $comment: <br />
<img src="%ATTACHURLPATH%/$name" alt="$name" $size />
-## <a name="Email Settings"></a> Email Settings
+## <a name="TWiki Platform Settings"></a> 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 = 
+ - 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]] | [[Know|Know/WebHome]] | [[Sandbox|Sandbox/WebHome]]
+ - %T% **NOTE:** To automatically list all non-hidden webs in alphabetical order, use the `%WEBLIST{}%` variable instead: <br />
+
+- 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
- TWiki webmaster email address:
- Set WIKIWEBMASTER = <webmaster@your.company>
+- TWiki webmaster name (first name and last name, e.g. `Fred Smith`):
+ - Set WIKIWEBMASTERNAME = TWiki Webmaster
+
- 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 =
+- 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 =
+
+### <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="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.
## <a name="Miscellaneous Settings"></a> Miscellaneous 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" />
+- Line break:
+ - Set BR = <br />
+
+- Bullet sign:
+ - Set BULLET = •
+
+- Line break and bullet: (useful in table cells)
+ - Set BB = <br />•
- Colored text: (see more [[StandardColors]]) <table border="1" cellpadding="0" cellspacing="0">
<tr>
- **_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 WHITE = <font>
- **WHITE looks like this**</font>
-- And finally:
+- And finally:<font> </font>
- Set ENDCOLOR =
- To finish colored text
+<a name="DocGraphics"></a>
+
+- 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" />
+
+- Background color of non existing topic: ( default `cornsilk` or `#FFFFCE` )
+ - Set NEWTOPICBGCOLOR = #FFFFCE
+
+- Font color of non existing topic: ( default `#0000FF` )
+ - Set NEWTOPICFONTCOLOR = #0000FF
+
+- [[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 ALLOWWEBMANAGE = [[TWikiAdminGroup]]
- Site-level preferences that are **not** allowed to be overridden by [[WebPreferences]] and user preferences:
- - Set FINALPREFERENCES = PREVIEWBGIMAGE, WIKIWEBMASTER, SMTPMAILHOST , SMTPSENDERHOST, ALLOWWEBMANAGE
+ - Set FINALPREFERENCES = PREVIEWBGIMAGE, WIKITOOLNAME, WIKIWEBMASTER, SMTPMAILHOST , SMTPSENDERHOST, ALLOWWEBMANAGE
## <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