Sites Web Preferences

The following settings are web preferences of the Sites 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 Sites web:
    • #Set WEBTOPICLIST = %WEBTOPICLIST%
#009900

  • Web-specific background color: (Pick a lighter one of the StandardColors).
    • Set WEBBGCOLOR = #009900
    • 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 TWikiLogos? topic; create your own logos topic instead.
    • Set WEBLOGONAME = EMS_Full_Logo_Color_40px.png
    • Set WIKILOGOIMG = /wiki/pub/Sites/WebPreferences/EMS_Full_Logo_Color_40px.png
    • Set WIKILOGOALT = Eugene Maker Space
    • Set WIKILOGOURL = http://www.eugenemakerspace.com

  • 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. Sites.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 =
    • Set SITEMAPUSETO =
    • 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

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

  • Users or groups who are not / are allowed to view / change / rename topics in the Sites 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

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 #009900
  • 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 Main.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

  • EMS Logo:
    EMS_Full_Logo_Color_40px.png

Topic attachments
I Attachment Action Size Date WhoSorted ascending Comment
EMS_Full_Logo_Color_40px.pngpng EMS_Full_Logo_Color_40px.png manage 9.9 K 14 Feb 2013 - 03:47 CordSlatton EMS Logo
favicon.icoico favicon.ico manage 1.1 K 14 Feb 2013 - 04:43 CordSlatton EMS Favicon (bug)
logo.gifgif logo.gif manage 2.5 K 12 May 2009 - 20:45 UnknownUser  
Topic revision: r14 - 14 Feb 2013 - 04:43:06 - CordSlatton
 

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 Eugene Maker Space Wiki? Send feedback