none
[openafs-wiki.git] / TWiki / TWikiPreferences.mdwn
index 7ff6035..c8ab1f7 100644 (file)
@@ -5,23 +5,29 @@ The following settings are **_site-level preferences_** , e.g. affecting all use
 **_Preferences:_**
 
 - List of %WIKITOOLNAME% webs: (the first line of a topic; to add a web see [[TWikiDocumentation]] and [[TWikiWebsTable]])
-  - Set WIKIWEBLIST = [%WIKITOOLNAME%](%WIKIHOMEURL%) . \{ [Main](http://www.dementia.org/twiki//view/Main/WebHome) | [TWiki](http://www.dementia.org/twiki//view/TWiki/WebHome) | [Know](http://www.dementia.org/twiki//view/Know/WebHome) | [Test](http://www.dementia.org/twiki//view/Test/WebHome) \}
+  - Set WIKIWEBLIST = [[Main|Main/WebHome]] | [[TWiki|TWiki/WebHome]] | [[Know|Know/WebHome]] | [[Test|Test/WebHome]]
+  - **_Note:_** To automatically list all non-hidden webs in alphabetical order you can use this variable instead: Set WIKIWEBLIST =
 
 - List of topics of a web: (the second line of a topic, is overwritten by web preferences)
-  - Set WEBTOPICLIST = %WEB% . \{ [Home](WebHome) | [Changes](WebChanges) | [Index](http://www.dementia.org/twiki//search/%WEB%/?scope=topic&regex=on&search=.*) | [Search](WebSearch) | Go <input name="topic" size="16" type="text" />
- \}
+  - Set WEBTOPICLIST = [[Home|Main/WebHome]] | [[Changes|Main/WebChanges]] | [[Index|Main/WebIndex]] | [[Search|Main/WebSearch]] | Go <input name="topic" size="16" type="text" />
 
 - Copyright notice:
   - Set WEBCOPYRIGHT = <font>Copyright © 2000 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>
 
-- Wiki webmaster email address:
-  - Set WIKIWEBMASTER = <Peter@Thoeny.com>
+- 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
 
-- Exclude web from a `web="all"` search: (Set to `on` for hidden webs; is overwritten by web preferences)
-  - Set NOSEARCHALL =
+- [[PreviewBackground]] image:
+  - Set PREVIEWBGIMAGE = ![previewbg.gif](http://www.dementia.org/twiki//view/TWiki/PreviewBackground/previewbg.gif)
+
+- Background color of non existing topic: ( default `cornsilk` or `#FFFFCE` )
+  - Set NEWTOPICBGCOLOR = #FFFFCE
+
+- Font color of non existing topic: ( default `#0000FF` )
+  - Set NEWTOPICFONTCOLOR = #0000FF
 
 - Horizontal size of text edit box: (can be overwritten by user preferences)
   - Set EDITBOXWIDTH = 70
@@ -29,17 +35,47 @@ The following settings are **_site-level preferences_** , e.g. affecting all use
 - Vertical size of text edit box: (can be overwritten by user preferences)
   - Set EDITBOXHEIGHT = 15
 
-- Default state of the **_link_** check box in the attach file page. Check box is initially checked if _Set ATTACHLINKBOX = CHECKED_ , 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)
+- 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 =
+
+- 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 =
 
+- Wiki webmaster email address:
+  - Set WIKIWEBMASTER = <webmaster@your.company>
+
+- Mail host for outgoing mail. This is used for [[TWikiNotificationOfChanges]] if Perl module <code>**Net::SMTP**</code> is installed. If not, sendmail is used instead (defined by <code>**$mailProgram**</code> in <code>**TWiki.cfg**</code>). Examples: `mail.your.company` or `localhost`
+  - Set SMTPMAILHOST = mail
+
+- [[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]]
+  - **_Note:_** In case you have a rough plugin you can disable all plugins with the <code>**$disableAllPlugins**</code> flag in the `TWiki.cfg` file.
+
 - http-equiv meta tags for **_view_**, **_rdiff_**, **_attach_**, **_search\*_** scripts:
-  - Set HTTP\_EQUIV\_ON\_VIEW =
 
-- http-equiv meta tags for **_edit_** script. Example to expire immediately: <br />`Set HTTP_EQUIV_ON_EDIT = <meta http-equiv="Expires" content="%GMTIME{"day month, year - hour:min:sec"}% GMT">`
-  - Set HTTP\_EQUIV\_ON\_EDIT =
+          * Set HTTP_EQUIV_ON_VIEW =
+
+- http-equiv meta tags for **_edit_** script. Example to expire immediately: <br />`Set HTTP_EQUIV_ON_EDIT = <meta http-equiv="Expires" content="%GMTIME{"$day $month, $year - $hour:$min:$sec"}% GMT">`
+
+          * Set HTTP_EQUIV_ON_EDIT =
 
 - http-equiv meta tags for **_preview_** script:
-  - Set HTTP\_EQUIV\_ON\_PREVIEW =
+
+          * Set HTTP_EQUIV_ON_PREVIEW =
+
+- Users or groups allowed to change this %TOPIC% topic: (I.e. [[TWikiAdminGroup]])
+  - Set ALLOWTOPICCHANGE =
+
+- Users or groups allow to rename this %TOPIC% topic:
+  - Set ALLOWTOPICRENAME = [[NobodyGroup]]
+
+- Site-level preferences that are **not** allowed to be overridden by [[WebPreferences]] and user preferences:
+  - Set FINALPREFERENCES = PREVIEWBGIMAGE, WIKIWEBMASTER, MAILHOST
 
 **_Notes:_**
 
@@ -55,3 +91,4 @@ The following settings are **_site-level preferences_** , e.g. affecting all use
 - [[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%` .
+- [[TWikiAccessControl]] explains how to restrict access by users or groups.