summaryrefslogtreecommitdiff
path: root/TWiki/TWikiPreferences.mdwn
blob: 7de230d14c65bf8d81fe95fc3225a2957c762b0d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
**%WIKITOOLNAME% Site-Level Preferences**

The following settings are **_site-level preferences_** , e.g. affecting all users in all %WIKITOOLNAME% webs. These preferences can be overwritten by **_web preferences_** (topic %WEBPREFSTOPIC% in each %WIKITOOLNAME% web) and **_user preferences_** (your personal topic, i.e. [[Main/TWikiGuest]] in the %WIKITOOLNAME%.%MAINWEB% web)

**_Preferences:_**

* List of %WIKITOOLNAME% webs: (the first line of a topic; to add a web see [[TWikiDocumentation]] and [[TWikiWebsTable]])
  * Set WIKIWEBLIST = [%WIKITOOLNAME%](%WIKIHOMEURL%) . \{ [Main](%SCRIPTURLPATH%/view%SCRIPTSUFFIX%/%MAINWEB%/%HOMETOPIC%) | [TWiki](%SCRIPTURLPATH%/view%SCRIPTSUFFIX%/%TWIKIWEB%/%HOMETOPIC%) | [Know](%SCRIPTURLPATH%/view%SCRIPTSUFFIX%/Know/%HOMETOPIC%) | [Test](%SCRIPTURLPATH%/view%SCRIPTSUFFIX%/Test/%HOMETOPIC%) \}

* List of topics of a web: (the second line of a topic, is overwritten by web preferences)
  * Set WEBTOPICLIST = %WEB% . \{ [Home](%HOMETOPIC%) | [Changes](WebChanges) | [Index](%SCRIPTURLPATH%/search%SCRIPTSUFFIX%/%WEB%/?scope=topic&regex=on&search=.*) | [Search](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:%WIKIWEBMASTER%?subject=%WIKITOOLNAME% Feedback) 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

* %TWIKIWEB%.PreviewBackground image:
  * Set PREVIEWBGIMAGE = %PUBURLPATH%/%TWIKIWEB%/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

* Vertical size of text edit box: (can be overwritten by user preferences)
  * Set EDITBOXHEIGHT = 15

* Default state of the **_Release edit lock_** 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 **_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@yourNOSPAM.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

* 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 /><code>Set HTTP\_EQUIV\_ON\_EDIT = &lt;meta http-equiv="Expires" content="%GMTIME\{"$day $month, $year - $hour:$min:$sec"\}% GMT"&gt;</code>

          * Set HTTP_EQUIV_ON_EDIT =

* http-equiv meta tags for **_preview_** script:

          * Set HTTP_EQUIV_ON_PREVIEW =

* Users or groups allowed to change this %TOPIC% topic: (I.e. %MAINWEB%.TWikiAdminGroup)
  * Set ALLOWTOPICCHANGE =

* Site-level preferences that are **not** allowed to be overridden by %WEBPREFSTOPIC% and user preferences:
  * Set FINALPREFERENCES = PREVIEWBGIMAGE, WIKIWEBMASTER, MAILHOST

**_Plugin Preferences:_**

* Installed [[TWikiPlugins]]: To enable/disable plugins, move them between ACTIVEPLUGINS and INACTIVEPLUGINS. Specify a comma separated list of plugin topics; the name of the web **_must_** be specified (i.e. <code>**TWiki.DefaultPlugin, TWiki.AnOtherPlugin**</code>)
  * Set ACTIVEPLUGINS = [[TWiki/DefaultPlugin]]
  * Set INACTIVEPLUGINS = [[TWiki/EmptyPlugin]]

* Preferences of [[DefaultPlugin]]:
  * Allow depreciated <code>%INCLUDE:"topic"%</code> syntax: (`0` or `1`)
    * Set DEFAULTPLUGIN\_OLDINCLUDE = 1

**_Notes:_**

* A preference is defined as: <br />`6 spaces * Set NAME = value`<br /> Example:
  * Set WEBBGCOLOR = #FFFFC0
* Preferences are used as %TWIKIWEB%.TWikiVariables by enclosing the name in percent signs. Example:
  * When you write variable <code>%WEBBGCOLOR%</code> , it gets expanded to `%WEBBGCOLOR%` .
* The sequential order of the preference settings is significant. Define preferences that use other preferences first, i.e. set <code>WEBCOPYRIGHT</code> before <code>WIKIWEBMASTER</code> since <code>%WEBCOPYRIGHT%</code> uses the <code>%WIKIWEBMASTER%</code> variable.
* You can introduce new variables and use them in your topics and templates. There is no need to change the %WIKITOOLNAME% engine (Perl scripts).

**_Related Topics:_**

* %WEBPREFSTOPIC% has preferences of the %WIKITOOLNAME%.%WEB% web.
* %MAINWEB%.%WIKIUSERSTOPIC% has a list of user topics. User topics can have optional user preferences.
* %TWIKIWEB%.TWikiVariables has a list of common <code>%VARIABLES%</code> .
* %TWIKIWEB%.TWikiAccessControl explains how to restrict access by users or groups.