MenuListPlugin

Folding menu list

Usage

Create a topic (in this example MenuTopic), containing a multi-level bullet list of web.topics you want to make a folding menu with.

Note: its important that the links include the web, as the menu may be referenced from another web.

Then add %MENULIST{topic="MenuTopic"}% to your sidebar.

If the currently viewed topic is in the list, MenuListPlugin will open up all the nodes leading up to where it is, and direct child nodes of this topic.

%MENULIST% parameters

parameter	values	default
mode	collapse,full	full
format, separator	see FormattedSearch	bullet list
quiet	in collapse mode, if you are not on a topic that is listed in the Menu topic, show nothing at all	false
showlevel	filters to only show menu entries of that level (works in both collapse and full mode)	unset (0)
showdenied	filters to only show menu entries that the current user has VIEW permission for	false
levels	how many levels of menu to show (single integer)	all (9999)

Examples

if MenuTopic contains

   * System.FoswikiSiteSkin 
      * System.FoswikiSiteSkinNavigationTemplate 
   * System.MoveableTypeSkin 
   * System.PatternSkin 
      * System.PatternSkinCss 
      * System.PatternSkinColorSettings 
      * System.PatternSkinCssCookbook 
         * System.PatternSkinCssCookbookCenterPage 
            * System.PatternSkinCssCookbookCenterPageBorder 
         * System.PatternSkinCssCookbookEditTableStyle 
         * System.PatternSkinCssCookbookFonts 
         * System.PatternSkinCssCookbookNoLeftBar 
         * System.PatternSkinCssCookbookNoTopBar 
      * System.PatternSkinCustomization 
      * System.PatternSkinElements 
      * System.PatternSkinGraphics 
      * System.PatternSkinHeaderArt 
      * System.PatternSkinWebCreateNewTopicTemplate 
   * System.PlainSkin 
   * System.PrintSkin 
   * System.Skins 
      * System.SkinBrowser 
      * System.SkinTemplates 
   * System.SlionSkin 
      * System.SlionSkinColorSettings 
      * System.SlionSkinCss 
      * System.SlionSkinCssCookbook 
         * System.SlionSkinCssCookbookCenterPageBorder 
         * System.SlionSkinCssCookbookCenterPage 
         * System.SlionSkinCssCookbookEditTableStyle 
         * System.SlionSkinCssCookbookFonts 
         * System.SlionSkinCssCookbookNoLeftBar 
         * System.SlionSkinCssCookbookNoTopBar 
      * System.SlionSkinCustomization 
      * System.SlionSkinElements 
      * System.SlionSkinGraphics 
      * System.SlionSkinHeaderArt 
      * System.SlionSkinWebCreateNewTopicTemplate 
   * System.WidgetsSkin 

and you added %MENULIST{topic="MenuTopic"}% to the WebLeftBar topic in the System web, then navigated to PatternSkinCssCookbook you would get

• FoswikiSiteSkin
• MoveableTypeSkin
• PatternSkin
  • PatternSkinCss
  • PatternSkinColorSettings
  • PatternSkinCssCookbook
    • PatternSkinCssCookbookCenterPage
    • PatternSkinCssCookbookEditTableStyle
    • PatternSkinCssCookbookFonts
    • PatternSkinCssCookbookNoLeftBar
    • PatternSkinCssCookbookNoTopBar
  • PatternSkinCustomization
  • PatternSkinElements
  • PatternSkinGraphics
  • PatternSkinHeaderArt
  • PatternSkinWebCreateNewTopicTemplate
• PlainSkin
• PrintSkin
• System.Skins
• SlionSkin
• WidgetsSkin

Installation Instructions

You do not need to install anything in the browser to use this extension. The following instructions are for the administrator who installs the extension on the server.

Open configure, and open the "Extensions" section. Use "Find More Extensions" to get a list of available extensions. Select "Install".

If you have any problems, or if the extension isn't available in configure, then you can still install manually from the command-line. See http://foswiki.org/Support/ManuallyInstallingExtensions for more help.

Info

Many thanks to the following sponsors for supporting this work:

• • http://blackfin.com.au/

Author(s):	Foswiki:Main.SvenDowideit
Copyright:	© 2009 SvenDowideit@fosiki.com
License:	GPL 3 (Gnu General Public License)
Version:	15636 (2012-10-18)
Change History:
18 Oct 2012:	added showdenied="off" mode to only show menu items the user is allowed to navigate to
8 May 2010:	added levels option so you can show several levels below showlevel, also changed output so that if you use showlevel the default ul bullet list starts from only one bullet level
1 Aug 2009:	added quiet param for collapsed view
22 Jul 2009:	add non-collapse mode, level and formatting so we can show a menu in a table
23 Mar 2009:	initial release
Dependencies:	None
Home page:	http://foswiki.org/bin/view/Extensions/MenuListPlugin
Support:	http://foswiki.org/bin/view/Support/MenuListPlugin