PI Web Preferences

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

Preferences:

• List of topics of the Foswiki.PI web:
  • Set WEBTOPICLIST = Changes  |  Index  |  Search  |  Go

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

• List this web in the SiteMap:
  • If yes, set SITEMAPLIST to on, do not set NOSEARCHALL, 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. PI.Topic links.
  • Set SITEMAPLIST = on
  • Set SITEMAPWHAT = ENEC -- Regional Piauí
  • Set SITEMAPUSETO = ... página da regional Piauí da ENEC

• Exclude web from a web="all" search: (Set to on for hidden webs)
  • Set NOSEARCHALL =

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

• 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)
  • System.WebTopicEditTemplate: Site-level default template
  • DataForms: How to enable form(s)
  • Set WEBFORMS =

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

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

• Web preferences that are not allowed to be overridden by user preferences:
  • 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:
  • Set WEBBGCOLOR = #FFFFC0
• Preferences are used as System.Macros by enclosing the name in percent signs. Example:
  • When you write variable %WEBBGCOLOR% , it gets expanded to #CCCCFF .
• 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.
• System.Macros has a list of common %VARIABLES%.
• AccessControl explains how to restrict access by users or groups.