none
authorPeterThoeny <PeterThoeny>
Wed, 16 Aug 2000 00:33:58 +0000 (00:33 +0000)
committerPeterThoeny <PeterThoeny>
Wed, 16 Aug 2000 00:33:58 +0000 (00:33 +0000)
TWiki/TWikiPreferences.mdwn [new file with mode: 0644]

diff --git a/TWiki/TWikiPreferences.mdwn b/TWiki/TWikiPreferences.mdwn
new file mode 100644 (file)
index 0000000..7ff6035
--- /dev/null
@@ -0,0 +1,57 @@
+**%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 [[WebPreferences]] in each %WIKITOOLNAME% web) and **_user preferences_** (your personal topic, i.e. [[TWikiGuest]] in the %WIKITOOLNAME%.Main 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](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) \}
+
+- 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" />
+ \}
+
+- 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>
+
+- 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 =
+
+- 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 **_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)
+  - Set ATTACHLINKBOX =
+
+- 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 =
+
+- http-equiv meta tags for **_preview_** script:
+  - Set HTTP\_EQUIV\_ON\_PREVIEW =
+
+**_Notes:_**
+
+- A preference is defined as: <br />`6 spaces * Set NAME = value`<br /> Example:
+  - Set WEBBGCOLOR = #FFFFC0
+- Preferences are used as [[TWikiVariables]] by enclosing the name in percent signs. Example:
+  - When you write variable `%WEBBGCOLOR%` , it gets expanded to `%WEBBGCOLOR%` .
+- The sequential order of the preference settings is significant. Define preferences that use other preferences first, i.e. set `WEBCOPYRIGHT` before `WIKIWEBMASTER` since `%WEBCOPYRIGHT%` uses the `%WIKIWEBMASTER%` 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:_**
+
+- [[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%` .