none
authorMikeMannix <MikeMannix>
Mon, 31 Dec 2001 06:59:00 +0000 (06:59 +0000)
committerMikeMannix <MikeMannix>
Mon, 31 Dec 2001 06:59:00 +0000 (06:59 +0000)
TWiki/TWikiPreferences.mdwn

index 6345a3b..fdafa6c 100644 (file)
@@ -1,14 +1,33 @@
-**%WIKITOOLNAME% Site-Level Preferences**
+# <a name="%WIKITOOLNAME% Site-Level Prefer"></a> %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)
+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).
 
-**_Preferences:_**
+- %X% **NOTE:** You can lock individual settings at the site or web levels using User &amp; Group Access Control - see section below.
 
-- List of %WIKITOOLNAME% webs: (the first line of a topic; to add a web see [[TWikiDocumentation]] and [[TWikiWebsTable]])
+<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="#Preferences Access Control"> Preferences Access Control</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>
+  </ul>
+</div>
+
+----
+
+## <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 [[TWikiWebsTable]]):
   - 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 =
+  - %T% **NOTE:** To automatically list all non-hidden webs in alphabetical order, use this variable instead: <br />Set WIKIWEBLIST =
 
-- List of topics of a web: (the second line of a topic, is overwritten by web preferences)
+- 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" />
 
 - Copyright notice:
@@ -46,57 +65,66 @@ The following settings are **_site-level preferences_** , e.g. affecting all use
 
 - Format of file link when the **_link_** check box is checked: (can be overwritten by user preferences)
   - Set ATTACHEDFILELINKFORMAT = \\t\* [$name](http://www.dementia.org/twiki//view/$name): $comment
-  - **_Note:_** Keyword `$name` gets expanded to filename; `$comment` to comment; `\t` to tab (3 spaces for bullets).
+  - %H% **NOTE:** Keyword <code>**$name**</code> gets expanded to filename; <code>**$comment**</code> to comment; <code>**\\t**</code> to tab (3 spaces for bullets).
 
 - Format of images when the **_link_** check box is checked: (can be overwritten by user preferences)
-  - Set ATTACHEDIMAGEFORMAT = \\t\* $comment: <br />![$name](http://www.dementia.org/twiki//view/$name)
-  - **_Note:_** Above image is shown as broken, it gets expanded correctly when you attach an image.
-  - **_Note:_** Keyword `$name` gets expanded to filename; `$comment` to comment; `$size` to `width="..." height="..."` attribute of `img` tag; `\t` to tab (3 spaces for bullets).
+  - Set ATTACHEDIMAGEFORMAT = \\t\* $comment: <br />![$name](http://www.dementia.org/twiki//view/$name) **_Example image is broken because there is no attached image file._**
+  - %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).
 
-- Wiki webmaster email address:
+## <a name="Email Settings"></a> Email Settings
+
+- TWiki webmaster email address:
   - Set WIKIWEBMASTER = <webmaster@your.company>
 
-- 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: `mail.your.company` or `localhost`
+- 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. Examples: `twiki.your.company`
+- 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
+
 - [[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.
+  - %T% **NOTE:** You can enable/disable all plugins with the <code>**$disableAllPlugins**</code> flag in the <code>**lib/TWiki.cfg**</code> file.
 
-- http-equiv meta tags for **_view_**, **_rdiff_**, **_attach_**, **_search\*_** scripts:
+## <a name="HTTP-EQUIV Settings"></a> HTTP-EQUIV Settings
+
+- <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 =
 
-- 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">`
+- <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">`
 
           * Set HTTP_EQUIV_ON_EDIT =
 
-- http-equiv meta tags for **_preview_** script:
+- <code>**http-equiv**</code> meta tags for <code>**preview**</code> script:
 
           * Set HTTP_EQUIV_ON_PREVIEW =
 
-- Users or groups allowed to change or rename this %TOPIC% topic: (I.e. [[TWikiAdminGroup]])
+## <a name="Preferences Access Control"></a> Preferences Access Control
+
+- Users or groups allowed to change or rename this %TOPIC% topic: (ex: [[TWikiAdminGroup]])
   - Set ALLOWTOPICCHANGE =
   - Set ALLOWTOPICRENAME =
 
 - Site-level preferences that are **not** allowed to be overridden by [[WebPreferences]] and user preferences:
   - Set FINALPREFERENCES = PREVIEWBGIMAGE, WIKIWEBMASTER, SMTPMAILHOST , SMTPSENDERHOST
 
-**_Notes:_**
+## <a name="Creating New Preference Variable"></a> Creating New Preference Variables
 
-- A preference is defined as: <br />`6 spaces * Set NAME = value`<br /> Example:
+You can introduce new VARIABLES and use them in your topics and templates. There is no need to change the TWiki engine (Perl scripts).
+
+- A preference is defined in a [[TWikiShorthand]] bullet item: <code>**[3 spaces] \* [space] Set NAME = value**</code><br /> Example (as a nested bullet item, indented 6 spaces):
   - 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).
+- Preferences are used as [[TWikiVariables]] by enclosing the name in percent signs: <code>**%**</code>. Example:
+  - When you write variable <code>**%WEBBGCOLOR%**</code>, it gets expanded to `%WEBBGCOLOR%` .
+
+- %X% The sequential order of the preference settings is significant. Define preferences that use other preferences FIRST. For example, set <code>**WEBCOPYRIGHT**</code> before <code>**WIKIWEBMASTER**</code> since the copyright notice uses the webmaster email address.
 
-**_Related Topics:_**
+## <a name="Related Topics"></a> Related Topics
 
 - [[WebPreferences]] has preferences of the %WIKITOOLNAME%.%WEB% web.
 - [[TWikiUsers]] has a list of user topics. User topics can have optional user preferences.