(r8) MenuListPlugin < Extensions

You are here: Foswiki>Extensions Web>Plugins>MenuListPlugin (revision 8) (raw view)

<!--
This topic is part of the documentation for MenuListPlugin and is
automatically generated from Subversion. You can edit it, but if you do,
please make sure the maintainer of the extension knows about your changes,
otherwise your edits might be lost the next time the topic is uploaded.

If you want to report an error in the topic, please raise a report at
http://foswiki.org/Tasks/MenuListPlugin
-->
---+!! !MenuListPlugin
<!--
One line description, required for extensions repository catalog.
      * Set SHORTDESCRIPTION = Folding menu list
-->
%SHORTDESCRIPTION%

%TOC%

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

Then add =%<nop>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.

---++ %<nop>MENULIST% parameters
| *parameter* | *values* | *default* |
| =mode= | collapse,full | =full= |
| =format=, =separator= | see %SYSTEMWEB%.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) |
| =levels= | how many levels of menu to show (single integer) | =all= (9999) |


---++ Examples

if =MenuTopic= contains 

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

and you added  =%<nop>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 
   * 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: | &copy; 2009 SvenDowideit@fosiki.com |
|  License: | [[http://www.gnu.org/licenses/gpl.html][GPL 3 (Gnu General Public License)]] |
|  Version: | 7345 (2010-05-08) |
|  Change History: | <!-- versions below in reverse order -->&nbsp; |
|  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 |

<!-- Do _not_ attempt to edit this topic; it is auto-generated. -->

PackageForm edit

ExtensionClassification	Information structuring and Search, Interface and Visualisation, User interactivity
ExtensionType	PluginPackage
Compatibility	1.0
DemoUrl	http://
SupportUrl	MenuListPlugin
DevelopedInSVN	Yes
ModificationPolicy	CoordinateWithAuthor

Topic attachments
I	Attachment	Action	Size	Date	Who
md5	MenuListPlugin.md5	manage	0.2 K	08 May 2010 - 05:00	SvenDowideit
sha1	MenuListPlugin.sha1	manage	0.2 K	08 May 2010 - 05:00	SvenDowideit
tgz	MenuListPlugin.tgz	manage	6.6 K	08 May 2010 - 04:59	SvenDowideit
zip	MenuListPlugin.zip	manage	8.8 K	08 May 2010 - 04:59	SvenDowideit
EXT	MenuListPlugin_installer	manage	4.1 K	08 May 2010 - 05:00	SvenDowideit

Topic revision: r8 - 08 May 2010, SvenDowideit

Extensions

Quick Links

Tools

The copyright of the content on this website is held by the contributing authors, except where stated elsewhere. see CopyrightStatement.