Difference: WebPreferences (1 vs. 42)

Revision 42
Changes from r40 to r42
Line: 1 to 1
Changed:
<
<
META TOPICPARENT name="WebHome"
>
>
META TOPICPARENT name="WebSystem"
 

Main Web Preferences

Line: 26 to 26
  If you intend to lock down the Main to only allow registration, you need to add the built in RegistrationAgent to the ALLOWWEBCHANGE setting.

  • Set DENYWEBVIEW =
Changed:
<
<
>
>
  • Set ALLOWWEBVIEW =
 
  • Set DENYWEBCHANGE =
  • Set ALLOWWEBCHANGE =
  • Set DENYWEBRENAME =
Revision 40
Changes from r38 to r40
Line: 1 to 1
 
META TOPICPARENT name="WebHome"

Main Web Preferences

Line: 26 to 26
  If you intend to lock down the Main to only allow registration, you need to add the built in RegistrationAgent to the ALLOWWEBCHANGE setting.

  • Set DENYWEBVIEW =
Changed:
<
<
  • Set ALLOWWEBVIEW =
>
>
 
  • Set DENYWEBCHANGE =
  • Set ALLOWWEBCHANGE =
  • Set DENYWEBRENAME =
Revision 38
Changes from r36 to r38
Line: 1 to 1
 
META TOPICPARENT name="WebHome"

Main Web Preferences

Deleted:
<
<		 The following settings are web preferences of the Main web. These preferences overwrite the site-level preferences in DefaultPreferences and SitePreferences, and can be overwritten by user preferences (your personal topic, eg: WikiGuest in the Main web).
 
Changed:
<
<

Web Preferences Settings

These settings override the defaults for this web only. See full list of defaults with explanation.
>
>

Appearance

 
Deleted:
<
<
 
    • Set WEBBGCOLOR = #FFEFA6
Changed:
<
<
    • Set SITEMAPWHAT = Welcome to Foswiki... Users, Groups
    • Set SITEMAPUSETO = ...see who is registered on this site
>
>
    • web-specific background color, current color
 
    • Set SITEMAPLIST = on
Added:
>
>
  • Set WEBSUMMARY = Welcome to Foswiki ... meet people on this site

Wiki application settings

 
Changed:
<
<
  • Default template for new topics for this web:
>
>
 
Deleted:
<
<
  • Comma separated list of forms that can be attached to topics in this web. See DataForms for more information.
 
Added:
>
>
    • Comma separated list of forms that can be attached to topics in this web. See DataForms for more information.

Access control

Users or groups who are allowed to view, change and rename topics in the Main web. Remember that an empty setting is a valid setting; setting DENYWEBVIEW to nothing means that anyone can view the web. If you intend to lock down the Main to only allow registration, you need to add the built in RegistrationAgent to the ALLOWWEBCHANGE setting.
 
Deleted:
<
<
  • Users or groups who are not / are allowed to view / change / rename topics in the Main web: (See AccessControl). Remove the # to enable any of these settings. Remember that an empty setting is a valid setting; setting DENYWEBVIEW to nothing means that anyone can view the web.
 
    • Set DENYWEBVIEW =
    • Set ALLOWWEBVIEW =
    • Set DENYWEBCHANGE =
Line: 32 to 32
 
    • Set DENYWEBRENAME =
    • Set ALLOWWEBRENAME =
Changed:
<
<
  • Users or groups allowed to change or rename this WebPreferences topic: (e.g., AdminGroup)
>
>		 Users or groups allowed to change or rename this WebPreferences topic: (e.g., AdminGroup)
 
Changed:
<
<
  • Web preferences that are not allowed to be overridden by sub-web, user or topic preferences:
    • Set FINALPREFERENCES = NOSEARCHALL, ATTACHFILESIZELIMIT, WIKIWEBMASTER, WEBCOPYRIGHT, WEBTOPICLIST, DENYWEBVIEW, ALLOWWEBVIEW, DENYWEBCHANGE, ALLOWWEBCHANGE, DENYWEBRENAME, ALLOWWEBRENAME
>
>
 

Tools

help

Help on Preferences

  • A preference setting lets you define a simple macro that can be expanded in your output. Preference settings do not accept any parameters.
  • A preference setting looks like this:
    3 or 6 spaces * Set NAME = value
    Example: 
       * Set WEBBGCOLOR = #FFFFC0
  • A preferences setting can be disabled with a # sign. Remove the # sign to enable a local customisation. Example:
       * #Set DENYWEBCHANGE = %USERSWEB%.UnknownUser
  • Macros defined using preference settings are expanded by enclosing the name in percent signs. Example:
    • When you write %WEBBGCOLOR%, it gets expanded to #FFEFA6
  • You can introduce your own preference settings and use them in your topics and templates.
  • A preference settings is always taken from the most current topic revision, even when accessing previous revisions of a topic.
  • Preferences can be defined in a number of places:
    1. DefaultPreferences (Foswiki upgrades overwrite this topic)
    2. SitePreferences
    3. Sub-webs inherit the WebPreferences of their parent
    4. WebPreferences
    5. In user topics, if the user has one (yours is WikiGuest)
    6. In (some) plugin documentation topics
    7. In the topic being accessed

HELP Set statements which occur at higher-numbered locations override settings of the same name at lower numbered levels, unless the macro was listed in a FINALPREFERENCES setting (finalised) at a lower-numbered level. In this case, the macro is locked to the value at that level; Set statements at higher-numbered levels are ignored.

If you are setting a preference and using it in the same topic, note that Foswiki reads all the preference settings from the saved version of the topic before it displays anything. This means you can use a macro anywhere in the topic, even if you set it somewhere inconspicuous near the end. But beware: it also means that if you change the setting of a macro you are using in the same topic, Preview will show the wrong thing, and you must Save the topic to see it correctly.

Also note that Foswiki always reads the setting from the most current topic revision, so viewing older revisions of a topic can show unexpected results.

The syntax for setting macros is the same anywhere:
[multiple of 3 spaces] * [space] Set [space] MACRONAME [space] = [space] value

Examples: 
   * Set MACRONAME = value
      * Set MACRONAME = value
Spaces between the = sign and the value will be ignored. You can split a value over several lines by indenting following lines with spaces - as long as you don't try to use * as the first character on the following line.

Example: 
   * Set MACRONAME = value starts here
     and continues here

Whatever you include in your Macro will be expanded on display, exactly as if it had been entered directly.

Example: Create a custom logo macro 
   * Set MYLOGO = %PUBURL%/%WEB%/LogoTopic/mylogo.gif

You can also set preference settings in a topic by clicking the link Edit topic preference settings under More topic actions. Preferences set in this manner are known as 'meta' preferences and are not visible in the topic text, but take effect nevertheless.

Access Control Settings

These are special types of preference settings to control access to content. AccessControl explains these security settings in detail.

Local values for preferences

Certain topics (user, plugin, web, site and default preferences topics) have a problem; macros defined in those topics can have two meanings. For example, consider a user topic. A user may want to use a double-height edit box when they are editing their home topic - but only when editing their home topic. The rest of the time, they want to have a normal edit box. This separation is achieved using Local in place of Set in the macro definition. For example, if the user sets the following in their home topic: 
   * Set EDITBOXHEIGHT = 10
   * Local EDITBOXHEIGHT = 20
Then, when they are editing any other topic, they will get a 10 high edit box. However, when they are editing their home topic they will get a 20 high edit box. Local can be used wherever a preference needs to take a different value depending on where the current operation is being performed.

Use this powerful feature with great care! %ALLVARIABLES% can be used to get a listing of the values of all macros in their evaluation order, so you can see macro scope if you get confused. 
<--  -->

Related Topics

Revision 36
Changes from r34 to r36
Line: 1 to 1
Changed:
<
<
META TOPICPARENT name="WebSystem"
>
>
META TOPICPARENT name="WebHome"
 

Main Web Preferences

Changed:
<
<		 The following settings are web preferences of the Main web. These preferences overwrite the site-level preferences in DefaultPreferences and SitePreferences, and can be overwritten by user preferences (your personal topic, eg: WikiGuest in the Main web).
>
>		 The following settings are web preferences of the Main web. These preferences overwrite the site-level preferences in DefaultPreferences and SitePreferences, and can be overwritten by user preferences (your personal topic, eg: WikiGuest in the Main web).
 

Web Preferences Settings

Changed:
<
<		 These settings override the defaults for this web only. See full list of defaults with explanation?.
>
>		 These settings override the defaults for this web only. See full list of defaults with explanation.
 

  • Web settings:
Changed:
<
<
>
>
 
    • Set WEBBGCOLOR = #FFEFA6
Changed:
<
<
    • Set SITEMAPWHAT = Welcome to Foswiki... Users, Groups
    • Set SITEMAPUSETO = ...see who is registered on this TWiki
>
>
    • Set SITEMAPWHAT = Welcome to Foswiki... Users, Groups
    • Set SITEMAPUSETO = ...see who is registered on this site
 
    • Set SITEMAPLIST = on

  • Default template for new topics for this web:
Changed:
<
<
  • Comma separated list of forms that can be attached to topics in this web. See TWikiForms? for more information.
>
>
  • Comma separated list of forms that can be attached to topics in this web. See DataForms for more information.
 
Changed:
<
<
  • Users or groups who are not / are allowed to view / change / rename topics in the Main web: (See TWikiAccessControl?). Remove the # to enable any of these settings. Remember that an empty setting is a valid setting; setting DENYWEBVIEW to nothing means that anyone can view the web.
>
>
  • Users or groups who are not / are allowed to view / change / rename topics in the Main web: (See AccessControl). Remove the # to enable any of these settings. Remember that an empty setting is a valid setting; setting DENYWEBVIEW to nothing means that anyone can view the web.
 
    • Set DENYWEBVIEW =
    • Set ALLOWWEBVIEW =
    • Set DENYWEBCHANGE =
Line: 32 to 32
 
    • Set DENYWEBRENAME =
    • Set ALLOWWEBRENAME =
Changed:
<
<
  • Users or groups allowed to change or rename this WebPreferences topic: (e.g., AdminGroup)
>
>
  • Users or groups allowed to change or rename this WebPreferences topic: (e.g., AdminGroup)
 

  • Web preferences that are not allowed to be overridden by sub-web, user or topic preferences:
    • Set FINALPREFERENCES = NOSEARCHALL, ATTACHFILESIZELIMIT, WIKIWEBMASTER, WEBCOPYRIGHT, WEBTOPICLIST, DENYWEBVIEW, ALLOWWEBVIEW, DENYWEBCHANGE, ALLOWWEBCHANGE, DENYWEBRENAME, ALLOWWEBRENAME

Tools

help

Help on Preferences

  • A preference setting lets you define a simple macro that can be expanded in your output. Preference settings do not accept any parameters.
  • A preference setting looks like this:
    3 or 6 spaces * Set NAME = value
    Example: 
       * Set WEBBGCOLOR = #FFFFC0
  • A preferences setting can be disabled with a # sign. Remove the # sign to enable a local customisation. Example:
       * #Set DENYWEBCHANGE = %USERSWEB%.UnknownUser
  • Macros defined using preference settings are expanded by enclosing the name in percent signs. Example:
    • When you write %WEBBGCOLOR%, it gets expanded to #FFEFA6
  • You can introduce your own preference settings and use them in your topics and templates.
  • A preference settings is always taken from the most current topic revision, even when accessing previous revisions of a topic.
  • Preferences can be defined in a number of places:
    1. DefaultPreferences (Foswiki upgrades overwrite this topic)
    2. SitePreferences
    3. Sub-webs inherit the WebPreferences of their parent
    4. WebPreferences
    5. In user topics, if the user has one (yours is WikiGuest)
    6. In (some) plugin documentation topics
    7. In the topic being accessed

HELP Set statements which occur at higher-numbered locations override settings of the same name at lower numbered levels, unless the macro was listed in a FINALPREFERENCES setting (finalised) at a lower-numbered level. In this case, the macro is locked to the value at that level; Set statements at higher-numbered levels are ignored.

If you are setting a preference and using it in the same topic, note that Foswiki reads all the preference settings from the saved version of the topic before it displays anything. This means you can use a macro anywhere in the topic, even if you set it somewhere inconspicuous near the end. But beware: it also means that if you change the setting of a macro you are using in the same topic, Preview will show the wrong thing, and you must Save the topic to see it correctly.

Also note that Foswiki always reads the setting from the most current topic revision, so viewing older revisions of a topic can show unexpected results.

The syntax for setting macros is the same anywhere:
[multiple of 3 spaces] * [space] Set [space] MACRONAME [space] = [space] value

Examples: 
   * Set MACRONAME = value
      * Set MACRONAME = value
Spaces between the = sign and the value will be ignored. You can split a value over several lines by indenting following lines with spaces - as long as you don't try to use * as the first character on the following line.

Example: 
   * Set MACRONAME = value starts here
     and continues here

Whatever you include in your Macro will be expanded on display, exactly as if it had been entered directly.

Example: Create a custom logo macro 
   * Set MYLOGO = %PUBURL%/%WEB%/LogoTopic/mylogo.gif

You can also set preference settings in a topic by clicking the link Edit topic preference settings under More topic actions. Preferences set in this manner are known as 'meta' preferences and are not visible in the topic text, but take effect nevertheless.

Access Control Settings

These are special types of preference settings to control access to content. AccessControl explains these security settings in detail.

Local values for preferences

Certain topics (user, plugin, web, site and default preferences topics) have a problem; macros defined in those topics can have two meanings. For example, consider a user topic. A user may want to use a double-height edit box when they are editing their home topic - but only when editing their home topic. The rest of the time, they want to have a normal edit box. This separation is achieved using Local in place of Set in the macro definition. For example, if the user sets the following in their home topic: 
   * Set EDITBOXHEIGHT = 10
   * Local EDITBOXHEIGHT = 20
Then, when they are editing any other topic, they will get a 10 high edit box. However, when they are editing their home topic they will get a 20 high edit box. Local can be used wherever a preference needs to take a different value depending on where the current operation is being performed.

Use this powerful feature with great care! %ALLVARIABLES% can be used to get a listing of the values of all macros in their evaluation order, so you can see macro scope if you get confused. 
<--  -->

Related Topics

Deleted:
<
<

META FILEATTACHMENT attr="" autoattached="1" comment="" date="1221190918" name="favicon.ico" path="favicon.ico" size="1406" version=""
META FILEATTACHMENT attr="" autoattached="1" comment="" date="1221190918" name="logo.gif" path="logo.gif" size="2545" version=""
Revision 34
Changes from r32 to r34
Line: 1 to 1
 
META TOPICPARENT name="WebSystem"

Main Web Preferences

Line: 25 to 25
 

  • Users or groups who are not / are allowed to view / change / rename topics in the Main web: (See TWikiAccessControl?). Remove the # to enable any of these settings. Remember that an empty setting is a valid setting; setting DENYWEBVIEW to nothing means that anyone can view the web.
Changed:
<
<
    • Set DENYWEBVIEW = ExternGroup?, ExGroup?
>
>
    • Set DENYWEBVIEW =
 
    • Set ALLOWWEBVIEW =
Changed:
<
<
    • Set DENYWEBCHANGE = ExternGroup?, ExGroup?
>
>
    • Set DENYWEBCHANGE =
 
    • Set ALLOWWEBCHANGE =
    • Set DENYWEBRENAME =
    • Set ALLOWWEBRENAME =
Revision 32
Changes from r30 to r32
Line: 1 to 1
 
META TOPICPARENT name="WebSystem"

Main Web Preferences

Line: 25 to 25
 

  • Users or groups who are not / are allowed to view / change / rename topics in the Main web: (See TWikiAccessControl?). Remove the # to enable any of these settings. Remember that an empty setting is a valid setting; setting DENYWEBVIEW to nothing means that anyone can view the web.
Changed:
<
<
>
>
    • Set DENYWEBVIEW = ExternGroup?, ExGroup?
 
    • Set ALLOWWEBVIEW =
Changed:
<
<
    • Set DENYWEBCHANGE = ExternGroup?
>
>
    • Set DENYWEBCHANGE = ExternGroup?, ExGroup?
 
    • Set ALLOWWEBCHANGE =
Changed:
<
<
    • Set DENYWEBRENAME = ExternGroup?
>
>
    • Set DENYWEBRENAME =
 
    • Set ALLOWWEBRENAME =

  • Users or groups allowed to change or rename this WebPreferences topic: (e.g., AdminGroup)
Revision 30
Changes from r28 to r30
Line: 1 to 1
 
META TOPICPARENT name="WebSystem"

Main Web Preferences

Line: 25 to 25
 

  • Users or groups who are not / are allowed to view / change / rename topics in the Main web: (See TWikiAccessControl?). Remove the # to enable any of these settings. Remember that an empty setting is a valid setting; setting DENYWEBVIEW to nothing means that anyone can view the web.
Changed:
<
<
>
>
 
    • Set ALLOWWEBVIEW =
Changed:
<
<
    • Set DENYWEBCHANGE =
>
>
    • Set DENYWEBCHANGE = ExternGroup?
 
    • Set ALLOWWEBCHANGE =
Changed:
<
<
    • Set DENYWEBRENAME =
>
>
    • Set DENYWEBRENAME = ExternGroup?
 
    • Set ALLOWWEBRENAME =

  • Users or groups allowed to change or rename this WebPreferences topic: (e.g., AdminGroup)
Revision 28
Changes from r26 to r28
Line: 1 to 1
Changed:
<
<
META TOPICPARENT name="WebHome"
>
>
META TOPICPARENT name="WebSystem"
 

Main Web Preferences

The following settings are web preferences of the Main web. These preferences overwrite the site-level preferences in DefaultPreferences and SitePreferences, and can be overwritten by user preferences (your personal topic, eg: WikiGuest in the Main web).
Line: 25 to 25
 

  • Users or groups who are not / are allowed to view / change / rename topics in the Main web: (See TWikiAccessControl?). Remove the # to enable any of these settings. Remember that an empty setting is a valid setting; setting DENYWEBVIEW to nothing means that anyone can view the web.
Changed:
<
<
>
>
 
    • Set ALLOWWEBVIEW =
    • Set DENYWEBCHANGE =
    • Set ALLOWWEBCHANGE =
Revision 26
Changes from r24 to r26
Line: 1 to 1
 
META TOPICPARENT name="WebHome"

Main Web Preferences

Line: 22 to 22
 

  • Comma separated list of forms that can be attached to topics in this web. See TWikiForms? for more information.
Changed:
<
<
>
>
 

  • Users or groups who are not / are allowed to view / change / rename topics in the Main web: (See TWikiAccessControl?). Remove the # to enable any of these settings. Remember that an empty setting is a valid setting; setting DENYWEBVIEW to nothing means that anyone can view the web.
Changed:
<
<
    • Set DENYWEBVIEW =
>
>
 
    • Set ALLOWWEBVIEW =
    • Set DENYWEBCHANGE =
    • Set ALLOWWEBCHANGE =
Line: 36 to 36
 
Changed:
<
<
  • Web preferences that are not allowed to be overridden by user or topic preferences:
>
>
  • Web preferences that are not allowed to be overridden by sub-web, user or topic preferences:
 
    • Set FINALPREFERENCES = NOSEARCHALL, ATTACHFILESIZELIMIT, WIKIWEBMASTER, WEBCOPYRIGHT, WEBTOPICLIST, DENYWEBVIEW, ALLOWWEBVIEW, DENYWEBCHANGE, ALLOWWEBCHANGE, DENYWEBRENAME, ALLOWWEBRENAME

Tools

help

Help on Preferences

  • A preference setting lets you define a simple macro that can be expanded in your output. Preference settings do not accept any parameters.
  • A preference setting looks like this:
    3 or 6 spaces * Set NAME = value
    Example: 
       * Set WEBBGCOLOR = #FFFFC0
  • A preferences setting can be disabled with a # sign. Remove the # sign to enable a local customisation. Example:
       * #Set DENYWEBCHANGE = %USERSWEB%.UnknownUser
  • Macros defined using preference settings are expanded by enclosing the name in percent signs. Example:
    • When you write %WEBBGCOLOR%, it gets expanded to #FFEFA6
  • You can introduce your own preference settings and use them in your topics and templates.
  • A preference settings is always taken from the most current topic revision, even when accessing previous revisions of a topic.
  • Preferences can be defined in a number of places:
    1. DefaultPreferences (Foswiki upgrades overwrite this topic)
    2. SitePreferences
    3. Sub-webs inherit the WebPreferences of their parent
    4. WebPreferences
    5. In user topics, if the user has one (yours is WikiGuest)
    6. In (some) plugin documentation topics
    7. In the topic being accessed

HELP Set statements which occur at higher-numbered locations override settings of the same name at lower numbered levels, unless the macro was listed in a FINALPREFERENCES setting (finalised) at a lower-numbered level. In this case, the macro is locked to the value at that level; Set statements at higher-numbered levels are ignored.

If you are setting a preference and using it in the same topic, note that Foswiki reads all the preference settings from the saved version of the topic before it displays anything. This means you can use a macro anywhere in the topic, even if you set it somewhere inconspicuous near the end. But beware: it also means that if you change the setting of a macro you are using in the same topic, Preview will show the wrong thing, and you must Save the topic to see it correctly.

Also note that Foswiki always reads the setting from the most current topic revision, so viewing older revisions of a topic can show unexpected results.

The syntax for setting macros is the same anywhere:
[multiple of 3 spaces] * [space] Set [space] MACRONAME [space] = [space] value

Examples: 
   * Set MACRONAME = value
      * Set MACRONAME = value
Spaces between the = sign and the value will be ignored. You can split a value over several lines by indenting following lines with spaces - as long as you don't try to use * as the first character on the following line.

Example: 
   * Set MACRONAME = value starts here
     and continues here

Whatever you include in your Macro will be expanded on display, exactly as if it had been entered directly.

Example: Create a custom logo macro 
   * Set MYLOGO = %PUBURL%/%WEB%/LogoTopic/mylogo.gif

You can also set preference settings in a topic by clicking the link Edit topic preference settings under More topic actions. Preferences set in this manner are known as 'meta' preferences and are not visible in the topic text, but take effect nevertheless.

Access Control Settings

These are special types of preference settings to control access to content. AccessControl explains these security settings in detail.

Local values for preferences

Certain topics (user, plugin, web, site and default preferences topics) have a problem; macros defined in those topics can have two meanings. For example, consider a user topic. A user may want to use a double-height edit box when they are editing their home topic - but only when editing their home topic. The rest of the time, they want to have a normal edit box. This separation is achieved using Local in place of Set in the macro definition. For example, if the user sets the following in their home topic: 
   * Set EDITBOXHEIGHT = 10
   * Local EDITBOXHEIGHT = 20
Then, when they are editing any other topic, they will get a 10 high edit box. However, when they are editing their home topic they will get a 20 high edit box. Local can be used wherever a preference needs to take a different value depending on where the current operation is being performed.

Use this powerful feature with great care! %ALLVARIABLES% can be used to get a listing of the values of all macros in their evaluation order, so you can see macro scope if you get confused. 
<--  -->

Related Topics

Added:
>
>

META FILEATTACHMENT attr="" autoattached="1" comment="" date="1221190918" name="favicon.ico" path="favicon.ico" size="1406" version=""
META FILEATTACHMENT attr="" autoattached="1" comment="" date="1221190918" name="logo.gif" path="logo.gif" size="2545" version=""
Revision 24
Changes from r22 to r24
Line: 1 to 1
 
META TOPICPARENT name="WebHome"

Main Web Preferences

Changed:
<
<		 The following settings are web preferences of the Main web. These preferences overwrite the site-level preferences in DefaultPreferences and SitePreferences, and can be overwritten by user preferences (your personal topic, eg: WikiGuest in the Main web).
>
>		 The following settings are web preferences of the Main web. These preferences overwrite the site-level preferences in DefaultPreferences and SitePreferences, and can be overwritten by user preferences (your personal topic, eg: WikiGuest in the Main web).
 

Web Preferences Settings

Changed:
<
<		 These settings override the defaults for this web only. See full list of defaults with explanation.
>
>		 These settings override the defaults for this web only. See full list of defaults with explanation?.
 

Line: 19 to 19
 

  • Default template for new topics for this web:
    • WebTopicEditTemplate: Default template for new topics in this web. (Site-level is used if topic does not exist)
Changed:
<
<
>
>
 
Changed:
<
<
  • Comma separated list of forms that can be attached to topics in this web. See DataForms for more information.
>
>
  • Comma separated list of forms that can be attached to topics in this web. See TWikiForms? for more information.
 
Changed:
<
<
  • Users or groups who are not / are allowed to view / change / rename topics in the Main web: (See AccessControl). Remove the # to enable any of these settings. Remember that an empty setting is a valid setting; setting DENYWEBVIEW to nothing means that anyone can view the web.
    • #Set DENYWEBVIEW =
    • #Set ALLOWWEBVIEW =
    • #Set DENYWEBCHANGE =
    • #Set ALLOWWEBCHANGE = AdminGroup
    • #Set DENYWEBRENAME =
    • #Set ALLOWWEBRENAME = AdminGroup

  • Users or groups allowed to change or rename this WebPreferences topic: (e.g., AdminGroup)
>
>
  • Users or groups who are not / are allowed to view / change / rename topics in the Main web: (See TWikiAccessControl?). Remove the # to enable any of these settings. Remember that an empty setting is a valid setting; setting DENYWEBVIEW to nothing means that anyone can view the web.
    • Set DENYWEBVIEW =
    • Set ALLOWWEBVIEW =
    • Set DENYWEBCHANGE =
    • Set ALLOWWEBCHANGE =
    • Set DENYWEBRENAME =
    • Set ALLOWWEBRENAME =

  • Users or groups allowed to change or rename this WebPreferences topic: (e.g., AdminGroup)
 

  • Web preferences that are not allowed to be overridden by user or topic preferences:
    • Set FINALPREFERENCES = NOSEARCHALL, ATTACHFILESIZELIMIT, WIKIWEBMASTER, WEBCOPYRIGHT, WEBTOPICLIST, DENYWEBVIEW, ALLOWWEBVIEW, DENYWEBCHANGE, ALLOWWEBCHANGE, DENYWEBRENAME, ALLOWWEBRENAME
Changed:
<
<		 Warning: Can't find topic TWiki.WebPreferencesHelp
>
>

Tools

help

Help on Preferences

  • A preference setting lets you define a simple macro that can be expanded in your output. Preference settings do not accept any parameters.
  • A preference setting looks like this:
    3 or 6 spaces * Set NAME = value
    Example: 
       * Set WEBBGCOLOR = #FFFFC0
  • A preferences setting can be disabled with a # sign. Remove the # sign to enable a local customisation. Example:
       * #Set DENYWEBCHANGE = %USERSWEB%.UnknownUser
  • Macros defined using preference settings are expanded by enclosing the name in percent signs. Example:
    • When you write %WEBBGCOLOR%, it gets expanded to #FFEFA6
  • You can introduce your own preference settings and use them in your topics and templates.
  • A preference settings is always taken from the most current topic revision, even when accessing previous revisions of a topic.
  • Preferences can be defined in a number of places:
    1. DefaultPreferences (Foswiki upgrades overwrite this topic)
    2. SitePreferences
    3. Sub-webs inherit the WebPreferences of their parent
    4. WebPreferences
    5. In user topics, if the user has one (yours is WikiGuest)
    6. In (some) plugin documentation topics
    7. In the topic being accessed

HELP Set statements which occur at higher-numbered locations override settings of the same name at lower numbered levels, unless the macro was listed in a FINALPREFERENCES setting (finalised) at a lower-numbered level. In this case, the macro is locked to the value at that level; Set statements at higher-numbered levels are ignored.

If you are setting a preference and using it in the same topic, note that Foswiki reads all the preference settings from the saved version of the topic before it displays anything. This means you can use a macro anywhere in the topic, even if you set it somewhere inconspicuous near the end. But beware: it also means that if you change the setting of a macro you are using in the same topic, Preview will show the wrong thing, and you must Save the topic to see it correctly.

Also note that Foswiki always reads the setting from the most current topic revision, so viewing older revisions of a topic can show unexpected results.

The syntax for setting macros is the same anywhere:
[multiple of 3 spaces] * [space] Set [space] MACRONAME [space] = [space] value

Examples: 
   * Set MACRONAME = value
      * Set MACRONAME = value
Spaces between the = sign and the value will be ignored. You can split a value over several lines by indenting following lines with spaces - as long as you don't try to use * as the first character on the following line.

Example: 
   * Set MACRONAME = value starts here
     and continues here

Whatever you include in your Macro will be expanded on display, exactly as if it had been entered directly.

Example: Create a custom logo macro 
   * Set MYLOGO = %PUBURL%/%WEB%/LogoTopic/mylogo.gif

You can also set preference settings in a topic by clicking the link Edit topic preference settings under More topic actions. Preferences set in this manner are known as 'meta' preferences and are not visible in the topic text, but take effect nevertheless.

Access Control Settings

These are special types of preference settings to control access to content. AccessControl explains these security settings in detail.

Local values for preferences

Certain topics (user, plugin, web, site and default preferences topics) have a problem; macros defined in those topics can have two meanings. For example, consider a user topic. A user may want to use a double-height edit box when they are editing their home topic - but only when editing their home topic. The rest of the time, they want to have a normal edit box. This separation is achieved using Local in place of Set in the macro definition. For example, if the user sets the following in their home topic: 
   * Set EDITBOXHEIGHT = 10
   * Local EDITBOXHEIGHT = 20
Then, when they are editing any other topic, they will get a 10 high edit box. However, when they are editing their home topic they will get a 20 high edit box. Local can be used wherever a preference needs to take a different value depending on where the current operation is being performed.

Use this powerful feature with great care! %ALLVARIABLES% can be used to get a listing of the values of all macros in their evaluation order, so you can see macro scope if you get confused. 
<--  -->

Related Topics

Revision 22
Changes from r20 to r22
Line: 1 to 1
 
META TOPICPARENT name="WebHome"

Main Web Preferences

Changed:
<
<		 The following settings are web preferences of the Main web. These preferences overwrite the site-level preferences in DefaultPreferences and SitePreferences, and can be overwritten by user preferences (your personal topic, eg: WikiGuest in the Main web).
>
>		 The following settings are web preferences of the Main web. These preferences overwrite the site-level preferences in DefaultPreferences and SitePreferences, and can be overwritten by user preferences (your personal topic, eg: WikiGuest in the Main web).
 

Revision 20
Changes from r18 to r20
Line: 1 to 1
 
META TOPICPARENT name="WebHome"
Changed:
<
<

Main Web Preferences

>
>

Main Web Preferences

 
Changed:
<
<		 The following settings are web preferences of the Main web. These preferences overwrite the site-level preferences in DefaultPreferences, and can be overwritten by user preferences (your personal topic, i.e. WikiGuest in the Foswiki.Main web)
>
>		 The following settings are web preferences of the Main web. These preferences overwrite the site-level preferences in DefaultPreferences and SitePreferences, and can be overwritten by user preferences (your personal topic, eg: WikiGuest in the Main web).
 
Added:
>
>
 
Changed:
<
<		 Preferences:
>
>

Web Preferences Settings

 
Changed:
<
<
>
>		 These settings override the defaults for this web only. See full list of defaults with explanation.
 
Changed:
<
<
  • Web specific background color: (Pick a lighter one of the StandardColors)
>
>
 
    • Set WEBBGCOLOR = #FFEFA6
Changed:
<
<

  • List this web in the SiteMap:
    • If yes, Set SITEMAPLIST = on, and add the "what" and "use to..." description for the site map. Make sure to list only links that include the name of the web, e.g. Main.Topic links.
>
>
    • Set SITEMAPWHAT = Welcome to Foswiki... Users, Groups
    • Set SITEMAPUSETO = ...see who is registered on this TWiki
 
    • Set SITEMAPLIST = on
Deleted:
<
<
    • Set SITEMAPWHAT = Welcome to Foswiki... Users, Groups, Offices? - tour this expandable virtual workspace.
    • Set SITEMAPUSETO = ...get a first-hand feel for TWiki possibilities.

  • Exclude web from a web="all" search: (Set to on for hidden webs)
    • Set NOSEARCHALL =
 
Changed:
<
<
  • Default template for new topics and form(s) for this web:
>
>
  • Default template for new topics for this web:
 
    • WebTopicEditTemplate: Default template for new topics in this web. (Site-level is used if topic does not exist)
Changed:
<
<

  • Users or groups who are not / are allowed to view / change / rename topics in the Main web: (See AccessControl)
    • Set DENYWEBVIEW =
    • Set ALLOWWEBVIEW =
    • Set DENYWEBCHANGE =
    • Set ALLOWWEBCHANGE =
    • Set DENYWEBRENAME =
    • Set ALLOWWEBRENAME =
>
>

  • Comma separated list of forms that can be attached to topics in this web. See DataForms for more information.
 
Changed:
<
<
  • Users or groups allowed to change or rename this WebPreferences topic: (I.e. AdminGroup)
    • Set ALLOWTOPICCHANGE =
>
>
  • Users or groups who are not / are allowed to view / change / rename topics in the Main web: (See AccessControl). Remove the # to enable any of these settings. Remember that an empty setting is a valid setting; setting DENYWEBVIEW to nothing means that anyone can view the web.
    • #Set DENYWEBVIEW =
    • #Set ALLOWWEBVIEW =
    • #Set DENYWEBCHANGE =
    • #Set ALLOWWEBCHANGE = AdminGroup
    • #Set DENYWEBRENAME =
    • #Set ALLOWWEBRENAME = AdminGroup

  • Users or groups allowed to change or rename this WebPreferences topic: (e.g., AdminGroup)
 
Changed:
<
<
  • Web preferences that are not allowed to be overridden by user preferences:
>
>
  • Web preferences that are not allowed to be overridden by user or topic preferences:
 
    • Set FINALPREFERENCES = NOSEARCHALL, ATTACHFILESIZELIMIT, WIKIWEBMASTER, WEBCOPYRIGHT, WEBTOPICLIST, DENYWEBVIEW, ALLOWWEBVIEW, DENYWEBCHANGE, ALLOWWEBCHANGE, DENYWEBRENAME, ALLOWWEBRENAME
Changed:
<
<		 Notes:
  • A preference is defined as:
    6 spaces * Set NAME = value
    Example:
    • Set WEBBGCOLOR = #FFFFC0
  • Preferences are used as Macros by enclosing the name in percent signs. Example:
    • When you write variable %WEBBGCOLOR% , it gets expanded to #FFEFA6 .
  • 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 preferences variables and use them in your topics and templates. There is no need to change the Foswiki engine (Perl scripts).

Related Topics:
  • DefaultPreferences has site-level preferences.
  • WikiUsers has a list of user topics. User topics can have optional user preferences.
  • Macros has a list of common %VARIABLES%.
  • AccessControl explains how to restrict access by users or groups.
>
>		 Warning: Can't find topic TWiki.WebPreferencesHelp
Revision 18
Changes from r16 to r18
Line: 1 to 1
 
META TOPICPARENT name="WebHome"

Main Web Preferences

Line: 11 to 11
 

  • Web specific background color: (Pick a lighter one of the StandardColors)
Changed:
<
<
    • Set WEBBGCOLOR = #FFFFC0
>
>
    • Set WEBBGCOLOR = #FFEFA6
 

  • List this web in the SiteMap:
    • If yes, Set SITEMAPLIST = on, and add the "what" and "use to..." description for the site map. Make sure to list only links that include the name of the web, e.g. Main.Topic links.
Line: 41 to 41
 

  • Web preferences that are not allowed to be overridden by user preferences:
Changed:
<
<
    • Set FINALPREFERENCES = NOSEARCHALL, WIKIWEBMASTER, WEBCOPYRIGHT, WEBTOPICLIST, DENYWEBVIEW, ALLOWWEBVIEW, DENYWEBCHANGE, ALLOWWEBCHANGE, DENYWEBRENAME, ALLOWWEBRENAME
>
>
    • Set FINALPREFERENCES = NOSEARCHALL, ATTACHFILESIZELIMIT, WIKIWEBMASTER, WEBCOPYRIGHT, WEBTOPICLIST, DENYWEBVIEW, ALLOWWEBVIEW, DENYWEBCHANGE, ALLOWWEBCHANGE, DENYWEBRENAME, ALLOWWEBRENAME
 

Notes:
  • A preference is defined as:
    6 spaces * Set NAME = value
    Example:
Revision 16
Changes from r14 to r16
Line: 1 to 1
 
META TOPICPARENT name="WebHome"

Main Web Preferences

Line: 38 to 38
 

  • Users or groups allowed to change or rename this WebPreferences topic: (I.e. AdminGroup)
    • Set ALLOWTOPICCHANGE =
Changed:
<
<
    • Set ALLOWTOPICRENAME =
>
>
 

  • Web preferences that are not allowed to be overridden by user preferences:
Changed:
<
<
    • Set FINALPREFERENCES = WEBTOPICLIST, DENYWEBVIEW, ALLOWWEBVIEW, DENYWEBCHANGE, ALLOWWEBCHANGE, DENYWEBRENAME, ALLOWWEBRENAME
>
>
    • Set FINALPREFERENCES = NOSEARCHALL, WIKIWEBMASTER, WEBCOPYRIGHT, WEBTOPICLIST, DENYWEBVIEW, ALLOWWEBVIEW, DENYWEBCHANGE, ALLOWWEBCHANGE, DENYWEBRENAME, ALLOWWEBRENAME
 

Notes:
  • A preference is defined as:
    6 spaces * Set NAME = value
    Example:
Revision 14
Changes from r12 to r14
Line: 1 to 1
 
META TOPICPARENT name="WebHome"
Changed:
<
<

Foswiki.Main Web Preferences

>
>

Main Web Preferences

 
Changed:
<
<		 The following settings are web preferences of the Foswiki.Main web. These preferences overwrite the site-level preferences in DefaultPreferences, and can be overwritten by user preferences (your personal topic, i.e. WikiGuest in the Foswiki.Main web)
>
>		 The following settings are web preferences of the Main web. These preferences overwrite the site-level preferences in DefaultPreferences, and can be overwritten by user preferences (your personal topic, i.e. WikiGuest in the Foswiki.Main web)
 

Preferences:

  • List of topics of the Foswiki.Main web:
Changed:
<
<
>
>
 

  • Web specific background color: (Pick a lighter one of the StandardColors)
    • Set WEBBGCOLOR = #FFFFC0

Changed:
<
<
    • If yes, Set SITEMAPLIST = on, and add the "what" and "use to..." description for the site map. Make sure to list only links that include the name of the web, e.g. Main.Topic links.
>
>
    • If yes, Set SITEMAPLIST = on, and add the "what" and "use to..." description for the site map. Make sure to list only links that include the name of the web, e.g. Main.Topic links.
 
    • Set SITEMAPLIST = on
    • Set SITEMAPWHAT = Welcome to Foswiki... Users, Groups, Offices? - tour this expandable virtual workspace.
    • Set SITEMAPUSETO = ...get a first-hand feel for TWiki possibilities.
Line: 28 to 28
 
    • DataForms: How to enable form(s)
    • Set WEBFORMS =
Changed:
<
<
  • Users or groups who are not / are allowed to view / change / rename topics in the Main web: (See AccessControl)
>
>
  • Users or groups who are not / are allowed to view / change / rename topics in the Main web: (See AccessControl)
 
    • Set DENYWEBVIEW =
    • Set ALLOWWEBVIEW =
    • Set DENYWEBCHANGE =
Revision 12
Changes from r10 to r12
Line: 1 to 1
 
META TOPICPARENT name="WebHome"

Foswiki.Main Web Preferences

Line: 13 to 13
 
  • Web specific background color: (Pick a lighter one of the StandardColors)
    • Set WEBBGCOLOR = #FFFFC0
Added:
>
>
  • List this web in the SiteMap:
    • If yes, Set SITEMAPLIST = on, and add the "what" and "use to..." description for the site map. Make sure to list only links that include the name of the web, e.g. Main.Topic links.
    • Set SITEMAPLIST = on
    • Set SITEMAPWHAT = Welcome to Foswiki... Users, Groups, Offices? - tour this expandable virtual workspace.
    • Set SITEMAPUSETO = ...get a first-hand feel for TWiki possibilities.
 
  • Exclude web from a web="all" search: (Set to on for hidden webs)
    • Set NOSEARCHALL =

  • Default template for new topics and form(s) for this web:
Changed:
<
<
    • TWikiFormTemplate?: How to enable form(s)
>
>
 
    • Set WEBFORMS =

  • Users or groups who are not / are allowed to view / change / rename topics in the Main web: (See AccessControl)
Revision 10
Changes from r8 to r10
Line: 1 to 1
Changed:
<
<		 Foswiki.Main Web Preferences
>
>
META TOPICPARENT name="WebHome"

Foswiki.Main Web Preferences

 

The following settings are web preferences of the Foswiki.Main web. These preferences overwrite the site-level preferences in DefaultPreferences, and can be overwritten by user preferences (your personal topic, i.e. WikiGuest in the Foswiki.Main web)
Line: 15 to 16
 
  • Exclude web from a web="all" search: (Set to on for hidden webs)
    • Set NOSEARCHALL =
Changed:
<
<
  • Users or groups who are not / are allowed to change/rename topics in the Main web: (See AccessControl)
>
>
  • Default template for new topics and form(s) for this web:
    • WebTopicEditTemplate: Default template for new topics in this web. (Site-level is used if topic does not exist)
    • WebTopicEditTemplate: Site-level default template
    • TWikiFormTemplate?: How to enable form(s)
    • Set WEBFORMS =

  • Users or groups who are not / are allowed to view / change / rename topics in the Main web: (See AccessControl)
    • Set DENYWEBVIEW =
    • Set ALLOWWEBVIEW =
 
    • Set DENYWEBCHANGE =
    • Set ALLOWWEBCHANGE =
    • Set DENYWEBRENAME =
Changed:
<
<
>
>
    • Set ALLOWWEBRENAME =
 
Changed:
<
<
  • Users or groups allowed to change this WebPreferences topic: (I.e. AdminGroup)
>
>
  • Users or groups allowed to change or rename this WebPreferences topic: (I.e. AdminGroup)
 
    • Set ALLOWTOPICCHANGE =
Added:
>
>
    • Set ALLOWTOPICRENAME =
 

  • Web preferences that are not allowed to be overridden by user preferences:
Changed:
<
<
    • Set FINALPREFERENCES = WEBTOPICLIST, DENYWEBVIEW, ALLOWWEBVIEW, DENYWEBCHANGE, ALLOWWEBCHANGE
>
>
    • Set FINALPREFERENCES = WEBTOPICLIST, DENYWEBVIEW, ALLOWWEBVIEW, DENYWEBCHANGE, ALLOWWEBCHANGE, DENYWEBRENAME, ALLOWWEBRENAME
 

Notes:
  • A preference is defined as:
    6 spaces * Set NAME = value
    Example:
Revision 8
Changes from r6 to r8
Line: 1 to 1
  Foswiki.Main Web Preferences

The following settings are web preferences of the Foswiki.Main web. These preferences overwrite the site-level preferences in DefaultPreferences, and can be overwritten by user preferences (your personal topic, i.e. WikiGuest in the Foswiki.Main web)
Line: 7 to 7
  Preferences:

  • List of topics of the Foswiki.Main web:
Changed:
<
<
>
>
 

  • Web specific background color: (Pick a lighter one of the StandardColors)
    • Set WEBBGCOLOR = #FFFFC0
Line: 24 to 15
 
  • Exclude web from a web="all" search: (Set to on for hidden webs)
    • Set NOSEARCHALL =
Changed:
<
<
  • Users or groups who are not / are allowed to change topics in the Main web: (See AccessControl)
>
>
  • Users or groups who are not / are allowed to change/rename topics in the Main web: (See AccessControl)
 
    • Set DENYWEBCHANGE =
    • Set ALLOWWEBCHANGE =
Added:
>
>
    • Set DENYWEBRENAME =
    • #Set ALLOWEBRENAME = AdminGroup
 

  • Users or groups allowed to change this WebPreferences topic: (I.e. AdminGroup)
    • Set ALLOWTOPICCHANGE =
Revision 6
Changes from r4 to r6
Line: 1 to 1
  Foswiki.Main Web Preferences

The following settings are web preferences of the Foswiki.Main web. These preferences overwrite the site-level preferences in DefaultPreferences, and can be overwritten by user preferences (your personal topic, i.e. WikiGuest in the Foswiki.Main web)
Line: 7 to 8
 

  • List of topics of the Foswiki.Main web:
    • Set WEBTOPICLIST = Main . {
Changed:
<
<		 Home | Users | Offices | Changes | Index | Search | Go
>
>		 Home | Users | Groups | Offices? | Changes | Index | Search | Go
  }

  • Web specific background color: (Pick a lighter one of the StandardColors)
Line: 33 to 35
 
    • Set FINALPREFERENCES = WEBTOPICLIST, DENYWEBVIEW, ALLOWWEBVIEW, DENYWEBCHANGE, ALLOWWEBCHANGE

Notes:
Changed:
<
<
  • A preference is defined as:
    6 spaces * Set NAME = value
    Example:
>
>
  • A preference is defined as:
    6 spaces * Set NAME = value
    Example:
 
    • Set WEBBGCOLOR = #FFFFC0
  • Preferences are used as Macros by enclosing the name in percent signs. Example:
    • When you write variable %WEBBGCOLOR% , it gets expanded to #FFEFA6 .
Revision 4
Changes from r2 to r4
Line: 16 to 16
  | Go }
Changed:
<
<
  • Web specific background color:
>
>
  • Web specific background color: (Pick a lighter one of the StandardColors)
 
    • Set WEBBGCOLOR = #FFFFC0

  • Exclude web from a web="all" search: (Set to on for hidden webs)
    • Set NOSEARCHALL =
Added:
>
>
  • Users or groups who are not / are allowed to change topics in the Main web: (See AccessControl)
    • Set DENYWEBCHANGE =
    • Set ALLOWWEBCHANGE =

  • Users or groups allowed to change this WebPreferences topic: (I.e. AdminGroup)
    • Set ALLOWTOPICCHANGE =

  • Web preferences that are not allowed to be overridden by user preferences:
    • Set FINALPREFERENCES = WEBTOPICLIST, DENYWEBVIEW, ALLOWWEBVIEW, DENYWEBCHANGE, ALLOWWEBCHANGE
  Notes:
  • A preference is defined as:
    6 spaces * Set NAME = value
    Example:
    • Set WEBBGCOLOR = #FFFFC0
Line: 34 to 44
 
  • DefaultPreferences has site-level preferences.
  • WikiUsers has a list of user topics. User topics can have optional user preferences.
  • Macros has a list of common %VARIABLES% .
Added:
>
>
  • AccessControl explains how to restrict access by users or groups.
Revision 2
19 Aug 2000 - PeterThoeny
Line: 1 to 1
  Foswiki.Main Web Preferences
Changed:
<
<		 The following settings are web preferences of the Foswiki.Main web. These preferences overwrite the site-level preferences in DefaultPreferences?, and can be overwritten by user preferences (your personal topic, i.e. PeterThoeny? in the Foswiki.Main web)
>
>		 The following settings are web preferences of the Foswiki.Main web. These preferences overwrite the site-level preferences in DefaultPreferences, and can be overwritten by user preferences (your personal topic, i.e. WikiGuest in the Foswiki.Main web)
 

Preferences:

  • List of topics of the Foswiki.Main web:
    • Set WEBTOPICLIST = Main . { Home
Changed:
<
<		 | Welcome | Users | Changes | Index
>
>		 | Users | Offices | Changes | Index
  | Search | Go }
Line: 18 to 19
 
  • Web specific background color:
    • Set WEBBGCOLOR = #FFFFC0
Added:
>
>
  • Exclude web from a web="all" search: (Set to on for hidden webs)
    • Set NOSEARCHALL =
  Notes:
  • A preference is defined as:
    6 spaces * Set NAME = value
    Example:
    • Set WEBBGCOLOR = #FFFFC0
Changed:
<
<
  • Preferences are used as TWikiVariables? by enclosing the name in percent signs. Example:
>
>
  • Preferences are used as Macros by enclosing the name in percent signs. Example:
 
    • When you write variable %WEBBGCOLOR% , it gets expanded to #FFEFA6 .
  • 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 preferences variables and use them in your topics and templates. There is no need to change the Foswiki engine (Perl scripts).

Related Topics:
Changed:
<
<
  • DefaultPreferences? has site-level preferences.
>
>
 
  • WikiUsers has a list of user topics. User topics can have optional user preferences.
Changed:
<
<
  • TWikiVariables? has a list of common %VARIABLES% .
>
>
  • Macros has a list of common %VARIABLES% .
View topic | History: r42 < r41 < r40 < r39 | More topic actions...
 
Das Urheberrecht © liegt bei den mitwirkenden Autoren. Alle Inhalte dieser Kollaborations-Plattform sind Eigentum der Autoren.