You are here: Foswiki>TIG Web>WebPreferences (18 Nov 2014, JaySekora)EditAttach

Foswiki.TIG Web Preferences

The following settings are web preferences of the Foswiki.TIG 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.TIG web:
    • Set WEBTOPICLIST =

  • 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. TIG.Topic links.
    • Set SITEMAPLIST = on
    • Set SITEMAPWHAT = TIG Documentation
    • Set SITEMAPUSETO = Document systems and services maintained by TIG

  • Exclude web from a web="all" search: (Set to on for hidden webs)
    • Set NOSEARCHALL =
  • Don't use these variables; see FoswikiAdministration
    • # Set SKIN = csailTIG
    • # Set BROADCASTMESSAGE =
    • # Set DS_QUICKLINKSHEADING = More links
    • # Set DS_QUICKLINKS =
    • # Set DS_LEFTMENUFONTSIZE = small
    • # Set DS_THEME = monochrome

  • Set WIKIWEBLIST =

  • 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
    • TWikiForms?: How to enable form(s)
    • Set WEBFORMS =

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

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

These settings, along with the System-wide WebTopBar, create the CSAIL-themed topbar: --

To replicate the topbar on another web, edit its WebPreferences to (1) #comment out any "Set SKIN" lines, and (2) replace any "Set WIKILOGO*" lines with this section.

  • Set CUSTOM_CSAILHEADER_FLAG = 1

  • Set WEBHEADERART = /wiki/pub/System/WebTopBar/header-bg-resources.gif
  • Set WEBHEADERBGCOLOR = #d8e5e8

  • Set PATTERNSKIN_THEME_VARIANT = /wiki/pub/System/WebTopBar/variant_foswiki_csailheader.css

  • Web specific background color: (The "RESOURCES green" www.csail.mit.edu is chosen below; this appears in various accents throughout the page.)
    • Set WEBBGCOLOR = #93BD2E

-- End of topbar section

  • Web preferences that are not allowed to be overridden by user preferences:
    • Set FINALPREFERENCES = 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 TWikiVariables? by enclosing the name in percent signs. Example:
    • When you write variable %WEBBGCOLOR% , it gets expanded to #93BD2E .
  • 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.
  • TWikiVariables? has a list of common %VARIABLES%.
  • TWikiAccessControl? explains how to restrict access by users or groups.
Topic revision: 18 Nov 2014, JaySekora
 

MIT Computer Science and Artificial Intelligence Laboratory

 

  • About CSAIL
  • Research
  • News + Events
  • Resources
  • People

This site is powered by Foswiki MIT: Massachusetts Institute of Technology