Quick Menu Skin

A functional skin that replaces the left bar with a customizable Javascript menu system.

Screen Shot

Installation

Note: You do not need to install anything on the browser to use this skin. The following instructions are for the administrator who installs the skin on the server where TWiki is running.

• Download the ZIP file from the Skin Home page (see below)
• Unzip QuickMenuSkin.zip in your twiki installation directory
• Test if installed: http://www.cleaver.org/twiki/bin/view/TWiki/QuickMenuSkin?skin=quickmenu
• For skin activation see TWikiSkins

Settings

The menu can behave in two ways. When CLICKMENU is set to 0 then the menu automatically shows when you hover the mouse over the menu. When it is set to 1 then the menu is activated by clicking on it. By default CLICKMENU is set to 0.

To add different menus to the menubar you can set QUICKMENUBAR to the topic containing the javascript for your own custom menus. By default QUICKMENUBAR is set to TWiki.QuickMenuBar, have a look at that topic to see how the menus are created.

To change settings just add them to TWikiPreferences, WebPreferences, or your personal page.
Eg:

   * Set CLICKMENU = 1
   * Set QUICKMENUBAR = %TWIKIWEB%.QuickMenuBar

Modifying Menus

The menu bar is built by default from TWiki.QuickMenuBar, which in turn includes TWiki.QuickMenuBarWebs (if login is enabled) and TWiki.QuickMenuBarWebs and TWiki.QuickMenuBarUtilities. These files contain javascript commands that are included by the skin's templates. You can edit these files to customize the menu, but be sure to avoid unwanted linking by enclosing your code in <noautolink> ... </noautolink> tags.

Note: In a future release, it will be possible to add icons to the menus in the menubar. When this is done the QuickMenu.Menu function will change! This will make the arguments similar to the QuickMenu.Menu.Add function in that the argument for an icon will be inserted before the "menu tip information" argument.

QuickMenu Javascript Reference

• To create a new menu
  Note: This may change! See above.
  mymenu = new QuickMenu.Menu(menuBar, "Menu Text", "", "Menu Tip Information");
  or just a link:
  new QuickMenu.Menu(menuBar, "TWiki.org", "http://twiki.org/");
  or a javascript function:
  new QuickMenu.Menu(menuBar, "Say Hello", "js:alert('Hello')");

• Add items to the menu
  mymenu.Add("Item Text", "%SCRIPTURLPATH{"view"}%/PageToView", "", "Item Tip");
mymenu.Add("Text Formatting", "%SCRIPTURLPATH{"view"}%/TextFormattingRules", "%ICONURLPATH{"help"}%", "More formatting help");
mymenu.Add("Disabled item");

• Add a submenu
  mymenu.Add("Choose Colour", ":Colour");
mymenu.Colour.Add(...

Skin Info

Description:	Functional skin that replaces the left bar with a customizable Javascript menu system
Screenshot:
Preview:	Preview with this topic
Base Name:	quickmenu
Skin Author:	TWiki:Main/VernonLyon
Skin Version:	4 Jul 2006 (v1.02)
Change History:
4 Jul 2006:	Added QUICKMENUBAR setting (v1.02)
21 Jun 2006:	Added "Account" menu (v1.01)
13 Jun 2006:	Initial version (v1.00)
Dependencies:
Skin Home:	http://TWiki.org/cgi-bin/view/Plugins/QuickMenuSkin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/QuickMenuSkinDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/QuickMenuSkinAppraisal

Note: The Description, Screenshot and Base Name rows are needed by the TWikiSkinBrowser

Related topic: TWikiSkins, TWikiSkinBrowser, UserDocumentationCategory, AdminDocumentationCategory

-- TWiki:Main/VernonLyon - 13 Jun 2006