## Gambas-Wiki.Gambas Web Preferences

The following settings are web preferences of the Gambas-Wiki.Gambas web. These preferences overwrite the site-level preferences in TWikiPreferences, and can be overwritten by user preferences (your personal topic, i.e. TWikiGuest in the Gambas-Wiki.Gambas web)

Preferences:

- List of topics of the Gambas-Wiki.Gambas web:
  - Set WEBTOPICLIST = Users | Changes | Search | Go

- Web specific background color: (Pick a lighter one of the StandardColors)
  - Set WEBBGCOLOR = #3398C3
  - Set WEBBGCOLOR = #A1E3FF

- 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. Gambas.Topic links.
  - Set SITEMAPLIST = on
  - Set SITEMAPWHAT = Welcome to Gambas-Wiki... Users, Groups, Offices - tour this expandable virtual workspace.
  - Set SITEMAPUSETO = ...get a first-hand feel for TWiki possibilities.

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

- 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)
  - TWiki.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 Gambas web: (See TWikiAccessControl)
  - Set DENYWEBVIEW =
  - Set ALLOWWEBVIEW =
  - Set DENYWEBCHANGE =
  - Set ALLOWWEBCHANGE =
  - Set DENYWEBRENAME =
  - Set ALLOWWEBRENAME =

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

- Web preferences that are not allowed to be overridden by user preferences:
  - Set FINALPREFERENCES = WEBTOPICLIST, DENYWEBVIEW, ALLOWWEBVIEW, DENYWEBCHANGE, ALLOWWEBCHANGE, DENYWEBRENAME, ALLOWWEBRENAME

- Gambas wiki specific variables
  - Set ARROW =

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 `#A1E3FF` .
- 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 Gambas-Wiki engine (Perl scripts).

Related Topics:

- TWikiPreferences has site-level preferences.
- TWikiUsers 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.