You are here: Extensions Web>WebPreferences (22 Nov 2009)

Extensions Web Preferences

The following settings are web preferences of the Extensions 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).

CommentPlugin

  • Per community vote in CommentPluginDiscussion there is a clear majority that wants it enabled or just don't care. And as Michael Daum has rightfully observed people still threadmode discuss. So I am reenabling the plugin and instead removing COMMENT from the templates where we do not want to encourage its use. -- KennethLavrsen.

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 Extensions web:

 #dcf1a5 
  • Web-specific background color: (Pick a lighter one of the StandardColors).
    • Set WEBBGCOLOR = #dcf1a5
    • 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.
    • #Set WEBLOGOIMG = foswiki-logo.png
    • #Set WEBLOGOURL = http://foswiki.org/
    • #Set WEBLOGOALT = Powered by Foswiki, The Free and Open Source Wiki

  • 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. Extensions.Topic links.
    Note: Unlike other variables, the setting of 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 = Applications, Extensions and Skins
    • Set SITEMAPUSETO = Documentation and downloads for extensions and skins
    • Note: Above settings are automatically configured when you create a web

  • 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

  • Users or groups who are not / are allowed to view / change / rename topics in the Extensions web: (See AccessControl).
    • 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)
    • 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

      * Set PACKAGE_SEARCH_TABLE_PARAMS = sort="off" tablewidth="100%" columnwidths="3%,20%,20%,27%,10%,10%"
      * Set PACKAGE_SEARCH_HEADER = | *<img src=\"%PUBURL%/%SYSTEMWEB%/DocumentGraphics/web-bg.gif\" alt=\"\" />* | *Classification* | *Package* | *Version* | *Download* | *Support* |
      * Set PACKAGE_SEARCH_FORMAT = | <img src=\"%PUBURL%/%WEB%/ExtensionType/icon$formfield(ExtensionType).gif\" alt=\"$formfield(ExtensionType)\" title=\"$formfield(ExtensionType)\" /> | $formfield(ExtensionClassification) | <b>[[$topic]]</b><br /><nop>$pattern(.*?\*\sSet\sSHORTDESCRIPTION\s\=([^\n\r]*).*) |$pattern(.*?Version\:?\s*\|([^\\n\r\|]*)\|.*)  | <a href='%PUBURL%/$web/$topic/$topic.zip'><img src=\"%PUBURL%/%SYSTEMWEB%/DocumentGraphics/download.gif\" alt=\"Download this package\" /></a> | [[Support.$topic][Support]] |

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 #dcf1a5
  • 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

Topic attachments
I Attachment Action Size Date Who Comment
bmpico favicon.ico manage 0.3 K 20 Nov 2004 - 18:14 ProjectContributor placeholder favicon
Topic revision: r30 - 22 Nov 2009 - 21:07:43 - KoenMartens
 
The copyright of the content on this website is held by the contributing authors, except where stated elsewhere. see CopyrightStatement. Creative Commons LicenseGet Foswiki at sourceforge.net. Fast, secure and Free Open Source software downloads