Difference: TWikiPreferences (21 vs. 22)

Revision 222001-12-31 - MikeMannix

Line: 1 to 1
Changed:
<
<
TWiki Site-Level Preferences
>
>

TWiki 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.guest).
  • ALERT! NOTE: You can lock individual settings at the site or web levels using User & Group Access Control - see section below.

 
Changed:
<
<
The following settings are site-level preferences , e.g. affecting all users in all TWiki webs. These preferences can be overwritten by web preferences (topic WebPreferences in each TWiki web) and user preferences (your personal topic, i.e. TWikiGuest in the TWiki.Main web)
>
>

General Preferences:

 
Changed:
<
<
Preferences:

>
>
 
Changed:
<
<
>
>
 
Changed:
<
<
  • 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):
 

  • Copyright notice:
Line: 47 to 49
 
  • Format of file link when the link check box is checked: (can be overwritten by user preferences)
    • Set ATTACHEDFILELINKFORMAT = \t* $name: $comment
Changed:
<
<
    • Note: Keyword $name gets expanded to filename; $comment to comment; \t to tab (3 spaces for bullets).
>
>
    • HELP NOTE: Keyword $name gets expanded to filename; $comment to comment; \t to tab (3 spaces for bullets).
 
  • Format of images when the link check box is checked: (can be overwritten by user preferences)
Changed:
<
<
    • Set ATTACHEDIMAGEFORMAT = \t* $comment:
      $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:
      $name Example image is broken because there is no attached image file.
    • HELP 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).

Email Settings

 
Changed:
<
<
  • Wiki webmaster email address:
>
>
  • TWiki webmaster email address:
 
Changed:
<
<
  • Mail host for outgoing mail. This is used for WebChangesAlert if Perl module Net::SMTP is installed. If not, or if SMTPMAILHOST is empty, the external sendmail program is used instead (defined by $mailProgram in TWiki.cfg). Examples: mail.your.company or localhost
>
>
  • Mail host for outgoing mail. This is used for WebChangesAlert if Perl module Net::SMTP is installed. If not, or if SMTPMAILHOST is empty, the external sendmail program is used instead (defined by $mailProgram in TWiki.cfg). Examples: mail.your.company or localhost
 
    • Set SMTPMAILHOST = mail
Changed:
<
<
  • Mail domain sending mail. SMTP requires that you identify the TWiki server sending mail. If not set, Net::SMTP 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, Net::SMTP will guess it for you. Ex: twiki.your.company
 
    • Set SMTPSENDERHOST =
Added:
>
>

Plugins Settings

 
Changed:
<
<
    • Note: In case you have a rough plugin you can disable all plugins with the $disableAllPlugins flag in the TWiki.cfg file.
>
>
    • TIP NOTE: You can enable/disable all plugins with the $disableAllPlugins flag in the lib/TWiki.cfg file.

HTTP-EQUIV Settings

 
Changed:
<
<
  • http-equiv meta tags for view, rdiff, attach, search* scripts:
>
>
  • http-equiv meta tags for view, rdiff, attach, search* scripts:
 
      * Set HTTP_EQUIV_ON_VIEW = 
Changed:
<
<
  • http-equiv meta tags for edit script. Example to expire immediately:
    Set HTTP_EQUIV_ON_EDIT = <meta http-equiv="Expires" content="%GMTIME{"$day $month, $year - $hour:$min:$sec"}% GMT">
>
>
  • http-equiv meta tags for edit script. Example, to expire immediately:
    Set HTTP_EQUIV_ON_EDIT = <meta http-equiv="Expires" content="%GMTIME{"day month, year - hour:min:sec"}% GMT">
 
      * Set HTTP_EQUIV_ON_EDIT = 
Changed:
<
<
  • http-equiv meta tags for preview script:
>
>
  • http-equiv meta tags for preview script:
 
      * Set HTTP_EQUIV_ON_PREVIEW = 
Changed:
<
<
  • Users or groups allowed to change or rename this TWikiPreferences topic: (I.e. TWikiAdminGroup)
>
>

Preferences Access Control

  • Users or groups allowed to change or rename this TWikiPreferences 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
Added:
>
>

Creating New Preference Variables

 
Changed:
<
<
Notes:
  • A preference is defined as:
    6 spaces * Set NAME = value
    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: [3 spaces] * [space] Set NAME = value
    Example (as a nested bullet item, indented 6 spaces):
 
    • Set WEBBGCOLOR = #FFFFC0
Changed:
<
<
  • Preferences are used as TWikiVariables by enclosing the name in percent signs. Example:
    • When you write variable %WEBBGCOLOR% , it gets expanded to #FFD8AA .
  • 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 TWiki engine (Perl scripts).
>
>
  • Preferences are used as TWikiVariables by enclosing the name in percent signs: %. Example:
    • When you write variable %WEBBGCOLOR%, it gets expanded to #FFD8AA .

  • ALERT! The sequential order of the preference settings is significant. Define preferences that use other preferences FIRST. For example, set WEBCOPYRIGHT before WIKIWEBMASTER since the copyright notice uses the webmaster email address.

Related Topics

 
Deleted:
<
<
Related Topics:
 
  • WebPreferences has preferences of the TWiki.TWiki web.
  • TWikiUsers has a list of user topics. User topics can have optional user preferences.
  • TWikiVariables has a list of common %VARIABLES% .
 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 1999-2019 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.TWikiPreferences.