Navigation Menu Config Application

Last modified by Andreea Popescu on 2021/03/17 21:48

cogSimple configuration tool for an instance of the navigation menu
Developed by

Anca Luca

0 Votes
LicenseGNU Lesser General Public License 2.1

Installable with the Extension Manager


This application adds tools for configuring the (horizontal) navigation menu for a page, built with the navigation menu wiki macro.

Starting with XWiki 5.1 the Menu Application provides an easier way to create and configure navigation menus.


  • To add a navigation menu to your wiki or to a space, go to Wiki Panels Administration (Wiki -> Administer Wiki -> Page elements) or space panels administration (< YourSpace> -> Administer Space -> Page Elements) and add MenuCode.MenuPanel to a list of panels of your wiki / space:


    Note that It's an invisible panel, so it won't affect your panels list. After a refresh you should see a horizontal navigation menu on top of your page:


  • In the Navigation Menu Config section of the wiki administration you can configure the list of menus / submenus that appear in this wiki. For example:


    Once you save this will result in:


For developers


You can customize this menu (relocate it, make it a vertical menu, etc) by copying the code from the MenuCode.MenuPanel and putting it wherever you find suited, according to the documentation in the navigation menu wiki macro, it will still stay configurable in the admin.

Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.

You can also use the following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:

  1. Log in the wiki with a user having Administration rights
  2. Go to the Administration page and select the Import category
  3. Follow the on-screen instructions to upload the downloaded XAR
  4. Click on the uploaded XAR and follow the instructions
  5. You'll also need to install all dependent Extensions that are not already installed in your wiki

In addition, do the following:

  • Configure MenuCode.Translations as an internationalization bundle in the localization section of the wiki administration

You need to have the navigation menu wiki macro extension before installing this extension.

Get Connected