Related topics: WebMenu, GnuSkinPlugin, TigerSkinPlugin , TWikiPlugins

WebMenu format


The left hand menu used in both the GnuSkin and the TigerSkin themes for the TWiki is defined by the WebMenu topic. Its format can, at first glance, seem a bit complex. The following sections tries to explain the syntax.

When used with the TigerSkin the left-hand menu bar is presented with advanced JavaScript features. Whereas the GnuSkin has an extremely simplified version enabled per default. As the JavaScript engine for presenting the WebMenu topic evolves more user agents, e.g., Mozilla, Netscape and Opera will get support for the more powerful JavaScript presentation. Currently only Internet Explorer is completely supported.


%WEB{name="..." home="..." [expand="always or never"]}% entry for Web
%ITEM{name="..." [topic="..."]}% topic in Web, any number of these after %WEB%
%LINK{name="..." [url="..."]}% Genric entry, an URL.
%DEFAULTITEMS% default topics defined by using SET DEFAULTITEMS

  • Only put one WebMenu command per line.

  • The WEB command creates a top-level menu item. Usually used to present a TWiki web with (possibly a different) name. Set the expand option to "always" if you always want this top-level item to be expanded (all sub-items displayed). Or set it to "never" to never expand it, not even when you are visiting that web.
    • %WEB{name="People" home="Main"}%

  • The ITEM command creates a sub-level item. Only two levels exist in the WebMenu, top-level and sub-top-level. The topic option denotes the actual web topic, with respect to the top-level web. The name option can be used to reference a topic with a different name. E.g., ChangeLog instead of WebChanges, for instance.
    • %ITEM{name="WebPreferences"}% — A sub-level item called WebPreferences which links to the same topic.

  • The LINK entry is a generic sub-level item. If you do not understand any of the others this one is for you. This can completely replace the ITEM above, if you like.

  • The DEFAULTITEMS is a set of sub-level items that are common for many webs. The setting is a comma separated list of items. Do NOT put any spaces between the comma and the following item!
    • Set DEFAULTITEMS = %ITEM{name="Preferences" topic="WebPreferences"}%,%ITEM{name="ChangeLog" topic="WebChanges"}%,%ITEM{name="WebNotify"}%,%ITEM{name="WebStatistics"}%

Please note: If you consult (as in copy-paste) the sources on this page, remove all <nop> statements in your text. Otherwise the settings will not work for you.

This topic: TWiki > TigerSkin  > WebMenuFormat
Topic revision: r3 - 2002-07-16 - 14:45:00 - TWikiGuest
This site is powered by the TWiki collaboration platformCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding NTP? Send feedback
Note: Please contribute updates to this topic on at TWiki:TWiki.WebMenuFormat