How to use the menu plugin in DokuWiki

DokuWiki has a plugin called the “menu” plugin that will allow you to place a custom navigation menu in your pages. This menu has nice icons separated out to each menu link catagory. The “menu” plugin that primarily works in the Wiki page code.  The following article will explain how to use the “menu” plugin.

Important! This menu only appears in the page you place the code in. To create a menu that is at the top of each page, please visit here.

Adding a menu to your DokuWiki with the menu plugin

The menu plugin can be a nice aesthetic to a page in your wiki. The menu plugin can be downloaded at the following link. Visit the following link and right click the download link on that page and save the link location.

Download menu plugin

You should have a link like the following.

ftp://ftp.berlios.de/pub/pbbuttons/plugin-menu.tgz

Take that url and use it in the following steps. The following steps will explain how to install install and use the menu module.

  1. Log into DokuWiki.
  2. Click the Admin link DokuWiki

    Click Admin at the top right.

  3. Click Manage Plugins DokuWiki

    Click Manage Plugins.

  4. Install Direct from URL DokuWiki

    Paste the download link in the Download and install a new plugintext box. In this case, the download link is the following.

    ftp://ftp.berlios.de/pub/pbbuttons/plugin-menu.tgz

    Click Download

    You should see a green confirmation box saying (1 plugin(s): menu) successfully installed.

    Upload images DokuWiki

    The menu plugin will now show in the Installed plugin list.

  5. Upload the images to DokuWiki

    Upload the icon images to the page you are adding the menu to.

  6. Insert the code for the plugin DokuWiki

    Add the following code to a page. Click here for how to edit a page.

    <menu col=2,itemwidth=20,align=center,caption="Menu">   <item>Item name 1|Item descr 1|[[Wiki link 1]]| {{Image 1}}</item>   <item>Item name 2|Item descr 2|[[Wiki link 2]]| {{Image 2}}</item>   <item>Item name 3|Item descr 3|[[Wiki link 3]]| {{Image 3}}</item> </menu> 

    You will need to supplement the following for your menu items.

    – Item name: The text you want for the link.
    – Item descr: Text that follows the link with information.
    – Wiki link: The path to your wiki page. For example, frequently_asked_question. This is obtained be visiting the page and getting the last variable in the URL.
    – Image: This is the image name you uploaded in step 5. For example, email.gif.

    Final view of menu pluigin Dokuwiki

    Save the page and now you should see the menu look like the snapshot to the right.


Leave a Reply