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