You are here: Foswiki>Home Web>WebPreferences (13 Jun 2011, MartinRowe)

Home Web Preferences

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

Web Preferences Settings

These settings override the defaults for this web only. See full list of defaults with explanation. Many of the settings below are commented out. Remove the # sign to enable a local customisation.

  • List of topics of the Home web:

 #66FF66  
  • Web-specific background color: (Pick a lighter one of the StandardColors).
    • Set WEBBGCOLOR = #66FF66
    • Note: This setting is automatically configured when you create a web

  • Image, URL and alternate tooltip text of web's logo.
    Note: Don't add your own local logos to the ProjectLogos topic; create your own logos topic instead.

  • List this web in the SiteMap. If you want the web listed, then set SITEMAPLIST to on, do not set NOSEARCHALL, and add the "what" and "use to..." description for the site map. Use links that include the name of the web, i.e. Home.Topic links.
    Note: Unlike other settings, SITEMAPLIST is not inherited from parent webs. It has to be set in every web that is to be listed in the SiteMap
    • Set SITEMAPLIST = on
    • Set SITEMAPWHAT =
    • Set SITEMAPUSETO =
    • Set ATTACHFILESIZELIMIT = 250000

  • Exclude web from a web="all" search: (Set to on for hidden webs).
    • Set NOSEARCHALL =
    • Note: This setting is automatically configured when you create a web

  • Prevent automatic linking of WikiWords and acronyms (if set to on); link WikiWords (if empty); can be overwritten by web preferences:
    • #Set NOAUTOLINK =
    • Note: You can still use the [[...][...]] syntax to link topics if you disabled WikiWord linking. The <noautolink> ... </noautolink> syntax can be used to prevents links within a block of text.

  • 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)
    • System.WebTopicEditTemplate: Site-level default topic template

  • Comma separated list of forms that can be attached to topics in this web. See DataForms for more information.
    • Set WEBFORMS =

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

  • Users or groups allowed to change or rename this WebPreferences topic: (e.g., AdminGroup)
    • Set ALLOWTOPICCHANGE = AdminGroup
    • Set ALLOWTOPICRENAME = nobody

  • 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

Help on Preferences

  • A preference setting lets you define a simple macro? that can be expanded in your output.
  • 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:
  • Macros defined using preference settings are expanded by enclosing the name in percent signs. Example:
    • When you write %WEBBGCOLOR%, it gets expanded to =#66FF66 =
  • The sequential order of the preference settings is significant. i.e. set WEBCOPYRIGHT before WIKIWEBMASTER since %WEBCOPYRIGHT% uses the %WIKIWEBMASTER% setting.
  • You can introduce your own preference settings and use them in your topics and templates.
  • Preferences can be defined in a number of places:
    1. DefaultPreferences
    2. SitePreferences
    3. Parent webs WebPreferences
    4. WebPreferences
    5. In user topics
    6. In Plugin documentation topics
    7. In topics
  • Preference settings can be finalised, which means they can't be redefined

Tools

Related Topics

 
This site is powered by FoswikiCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding Foswiki? Send feedback