This plugin allows you to insert a fully customizable index or a list of pages starting from a specified namespace. It should be useful in DokuWiki sites where pages are organized by namespaces. Main features are:

• Fully customizable with a lot of flexible options, but easy to use and configure for standard needs.
• Built-in support of Navigation features like highlighting the current location or dynamically displaying the tree of the current namespace.
• Easily themeable with prebuilt JavaScript themes.
• Assign Namespaces title and link (headpages) to namespaces.
• Sortable by date, title and custom metadata information.
• AJAX support to speed up sites with many pages.
• Customizable context mouse menu for usual namespace/page actions.
• TOC pages preview.
• Replace the DokuWiki page index.
• Hide namespaces/pages according to ACLs and plugin settings.

Themed indexmenu based on the Javascript index builder:

Indexmenu based on Dokuwikis index builder:

• You can test it at the playground page of the indexmenu web site.
• Thanks to Geir Landrö and his JavaScript dTree menu.
• Thanks also to Roland Hellebart and his Tree plugin for the dTree idea.
• Many many thanks to indexmenu users, the most useful work is done by them (look at the discussion page).
• Feel free to improve it.

The indexmenu plugin is not sponsored by anyone but I develop and support it for free during my spare time. If you want to offer me a friendly beer ¹⁾, you can consider to make a donation.

Basic syntax usage:

Arguments inside [] parenthesis are optional. The # char is always required with related options.

All the syntax options can be easily accessed with the indexmenu picker in the edit window toolbar.

Minimum syntax:

{{indexmenu>.}}, {{indexmenu>:}} or {{indexmenu>|}}. That means this {{indexmenu}} and this {{indexmenu>}} do not work.

Settings before the “|” separator:

Optional settings after the “|” separator (separated by spaces):

The js option uses so far the JavaScript dTree menu for displaying the pages. Unfortunately, this tree is not maintained and changes are needed. The old js tree is deprecated. It can be requested with the treeold, if the default setting is changed.

To replace it, the JavaScript Fancytree menu is implemented. Use the option treenew to activate it. If the implementation appears to be stable, it will be come the default tree. You can already make it default by adding treenew to the defaultoptions setting in the Configuration Manager.

A sample of an indexmenu JS index that could be used inside a navigation sidebar. Its initial status is blocked by the nocookie option, so, when the page is reloaded, it doesn't remember the open and closed nodes by the user:

{{indexmenu>:#1|js navbar nocookie}}

JS navigation index with “thread” theme where nodes after the third level are retrieved with Ajax every 2 sublevels. Pages are sorted by title and custom sort number:

{{indexmenu>:#1|js#thread navbar max#3#2 tsort msort}}

Standard DokuWiki index showing only pages inside wiki:plugins and lower namespaces (max two levels):

{{indexmenu>:wiki:plugins#2|nons}}

JS tree showing pages and namespaces both sorted by reverse title. For example, if “archive” contains stuff (“news”, “oldnews”, etc.) that you need to quickly organize by time, you could create numbered headpages for every namespace (i.e. renaming “oldnews” in “news 2006”, “news” in “news 2010” and so on) and sort them from new to older:

{{indexmenu>:archive#1|js tsort nsort rsort}}

Standard index showing the tree of the current context⁵⁾ opened at the second level.

{{indexmenu>playground#2|context}}

Show all current namespace pages.

{{indexmenu>.:#1|context}}

JS tree showing all (and only) the namespaces of the “private” namespace sorted by date creation. “private” is relative and refers to the private namespace under the page containing the indexmenu syntax.

{{indexmenu>private|js nopg dsort}}

By default nodes on the same tree level are sorted by name (or by title/date if you use the tsort/dsort syntax), but you can also specify a custom sort number for every page inserting a metadata tag in the pages with this syntax:

{{indexmenu_n>N}}

Where N is a number. Then you need to use the “msort” option in your indexmenu tree syntax. If you have the show_sort option enabled in the Configuration Manager, a notice is displayed to admins (only) on every page with this metadata tag (the text defaults to “Indexmenu sort number: N”).

Examples:

You can change the order of this tree containing a mix of standard and useheading pages:

-Root
  |_don
  |_Mirror sessions         (headline title of the ":mirror" page)
  |_pachuco
  |_At the radar station    (headline title of the ":radar" page)
  |_van
  |_vliet

in this way:

{{indexmenu>:#1|msort}}

-Root
  |_vliet                   {{indexmenu_n>1}}
  |_van                     {{indexmenu_n>2}}
  |_don                     {{indexmenu_n>3}}
  |_Mirror sessions         (headline title of the ":mirror" page)
  |_pachuco
  |_At the radar station    (headline title of the ":radar" page)

Pages without sort number, like the last three pages, are sorted by page name as default, but you can force a different sort:

{{indexmenu>:#1|tsort msort}}

-Root
  |_vliet                   {{indexmenu_n>1}}
  |_van                     {{indexmenu_n>2}}
  |_don                     {{indexmenu_n>3}}
  |_At the radar station    (headline title of the ":radar" page)
  |_Mirror sessions         (headline title of the ":mirror" page)
  |_pachuco

Indexmenu is fully configurable from Configuration Manager. Options are explained in the below sections.

Default options let you define settings that are applied to all the indexmenu indexes included in pages. To undo any syntax option, use the inverse version of the option. Normally that option is the same but with or without no... See the table above for all undo options.

It prevents no-admin users from inserting indexmenu trees, removing every indexmenu syntax in the page. It affects only the edit mode, so that standard users are still able to view indexmenu tree in a page edited by admins.

This is useful to deny to insert indexmenu trees to your users, but pay attention that if you let them to edit a page containing an indexmenu tree inserted by the admin, this tree will be removed as soon as a standard user saves the page.

Optimize the cache of indexmenu according to ACLs and prevents to display unauthorized nodes.

The choice of the method affects only the visualization of nodes on the indexmenu tree, not the page authorizations. The Groups option is the default setting.

• None: Standard. It is the faster method and it does not create further cache files, but the nodes with denied permission could be showed to unauthorized users or vice versa. Recommended when you don't deny pages access by ACL or you don't care how the tree is displayed or you use the ~~NOCACHE~~ syntax in the indexmenu page.
• User: Per-User login. Slower method and it creates a lot of cache files (depending on the amount of your DokuWiki site users, so for sites with few users it's not a problem), but it always hides correctly denied pages. Recommended when you have page ACLs that depend on users login.
• Groups: Per-groups membership. Good compromise between the previous methods, but in case that you deny pages read ACL to a single user login, he could anyway displays that nodes in the tree. Recommended when your whole site ACLs depend on groups membership.

If wrongly set, this option could display to a group of users (ie. the anonymous user) the cached tree of another group (ie: the admin user), thus displaying randomly different trees containing less or more (un)authorized nodes.

There are also important issues in about ACLs and about_empty_namespaces that affects trees limited by ACLs.

First of all, if you want that the whole tree displays the heading title of pages instead of their name, you need to set the config setting useheading on in the general configuration of the wiki. Indexmenu will show page titles when useheading is 'always' or 'navigation'.

Next, if you want that the namespace nodes display a heading title instead of the namespace name, you need to select the page from which these are retrieved with the config option headpage.

Every namespace will retrieve its title from the heading title of that page, called headpage, and will be linked directly to it. No longer you can open the node by clicking the header (in the js version you can still use the plus before namespace).

You can choose a name for the page from which retrieve the title or use a self defined value:

You can specify more than one option using “,” as separator. For every namespace, every value will be checked till the first existent headpage is found.

To get a better visualization you could use the hide_headpage option, that hides headpages, such as defined by config headpage, in the rendered indexmenu tree.

When this option is not empty, the DokuWiki default index page is replaced with a custom page, which you can fill yourself. For example you can add the indexmenu tree of your site.

Set this option with a DokuWiki page ID (i.e: tools:index), then create the page (i.e: tools:index) and put inside it an indexmenu syntax like this:

{{indexmenu>:|navbar}}

or

{{indexmenu>:|js navbar nocookie}}

You may also want to hide this page in any indexmenu trees with the skip files in index option.

You can show a custom message in place of the menu tree if it can not be rendered (i.e namespace doesn't exist)

The alias {{ns}} is a shortcut for the requested namespace.

Message supports the wiki syntax, so it's fully customizable. Don't use HTML code.

The configuration setting skip_index let you globally hide namespaces (and their pages) in your indexmenu trees.

Just fill this option with the ids of namespaces to skip using Regular Expression.
Till V4.5, a namespaces full path has to be declared as a file system path (i.e.: “mydir/mysubdir”) instead of DokuWiki IDs.

There are also some issues About empty namespaces that should be read.

Simple examples:
Skip any namespace whose ID contains the word copyright or privatens:users. Attention: allprivatens:usersmich will be also matched

/(copyright|privatens:users)/

Skip the namespace whose ID is exactly myusers:spaces. Here the characters ^ and $ marks the start and the end of the matched string.

/^myusers:spaces$/

This configuration option skip_file let you to globally hide one or more pages in your indexmenu trees. Just fill this option with the ids of pages to skip using Regular Expression.
Till v4.5, pages are checked as DokuWiki text files (i.e.: start.txt). A page full path have to be declared as a file system path (i.e.: “mydir/start.txt”) instead of DokuWiki IDs.

There are also some issues About empty namespaces that should be read.

If you sorted a page with the metadata tag syntax, a short blob message at the top of page will display its sort number.

The message is displayed only to wiki admins when they view the page.

Search and install the plugin using the Extension Manager. Refer to Plugins on how to install plugins manually.

Alternative download link: http://samuele.netsons.org/dokuwiki/media/indexmenu.zip

Old releases

• Merge pull request #319 from eduardomozart/patch-10 (2024-09-28 16:36)
• Fix event handling (2024-09-27 19:33)
• Merge pull request #293 from eduardomozart/patch-5 (2024-02-01 13:34)
• Merge pull request #292 from eduardomozart/patch-4 (2024-02-01 13:32)
• Open links on a new tab when Ctrl (Win) / Command (macOS) key is pressed (2024-02-01 13:32)
• Merge pull request #289 from eduardomozart/patch-3 (2024-02-01 13:31)
• Add data-wiki-id attr to Fancytree (Treenew) (2024-02-01 13:15)
• Merge pull request #287 from dokuwiki-translate/lang_update_795_17060… (2024-01-30 16:41)
• Fix TOC on IndexMenu by adding data-wiki-id attr (2024-01-30 13:39)
• Improve compatibility with Read the Dokus template (2024-01-30 13:32)

For development separated branches of the code are created to test features and bug fixes. See the list of current branches: https://github.com/samuelet/indexmenu/branches

Before installing a development version be sure to have first manually deleted the old indexmenu directory. Also be sure that, as last step, server/client cache is purged following 4 and 5 of the the tree is not displayed section.

At this moment some languages are supported , but I'll be glad if you want translate indexmenu in your own language. Please refer to translation tool at http://translate.dokuwiki.org/ to translate the strings of the indexmenu plugin. Thanks!

With the option js you enable the JavaScript tree menu, for which you can chosen some themes. When the js option is used without #theme option, the JavaScript indexmenu will use the default theme.

The indexmenu has already a couple of themes included. Adding another theme is simply as adding another folder with the theme name filled with the relevant files. (As long as it is still available you can use the admin page for installing themes). If you share your theme, we can add it to the collection as well. Please offer the files by opening an issue at GitHub.

The JavaScript tree menu is based on dTree code.

You can create custom themes for every index rendered with the dTree menu.

Simply create a subdirectory, for example mytheme, inside indexmenu/images and put inside it your icons following the default theme scheme:

Icon	Type	Example: theme 'default'
base.gif	Root Folder
folderopen.gif	Open folder without URL link
folder.gif	Closed folder without URL link
folderhopen.gif	Open folder with URL link (headpage)
folderh.gif	Closed folder with URL link (headpage)
page.gif	Page
plus.gif
minus.gif
nolines_plus.gif
nolines_minus.gif
minusbottom.gif
plusbottom.gif
join.gif
joinbottom.gif
line.gif
empty.gif	blank image to fill gap between lines

Use your theme with js#mytheme syntax.

You can also customize a theme style further by creating its own css style as style.css file in theme folder next to the images.

The default icons file format is GIF, but PNG and JPG are also supported. To use them in place of GIF, you have to name your theme directory with the appropriate image extension. For example: mytheme.png/base.png. Default image size is 18x18px. Other sizes are possible, but requires additional css.

An action menu is displayed when using the context mouse menu click (the right one in many cases). On Opera you can use the CTRL+left click to display it. When in editing mode, by default an “Insert as DWlink” item menu is added to the menu in order to insert the node DokuWiki link in your editing box. A different context menu is loaded depending on anonymous, authenticated or admin users.

In the April 2013 release of the plugin the contextmenu definition is bundled in scripts/contextmenu.js. Be aware this file is overwritten on update of the plugin. Therefore an additional file scripts/contextmenu.local.js is provided, you need to change this file to modify the appearance of the contextmenu.

Since the April 2013 plugin release you can add the nomenu option to indexmenu syntax to disable the contextmenu.

Modification of menu in performed in scripts/contextmenu.local.js:
(You can rename the example file from scripts/contextmenu.local.js.example)

• Overriding menu entry
  

  indexmenu_contextmenu['all']['pg']['view'][0] = ['Custom Title'];

• Adding menu entry
  

  indexmenu_contextmenu['all']['pg']['view'].splice(
      3, 
      0, 
      ['Input new page', '"javascript: IndexmenuContextmenu.reqpage(\'"+index.config.urlbase+"\',\'"+index.config.sepchar+"\',\'"+node.dokuid+"\');"']
   );

• Removing menu entry:
  • Override with empty array: []
  • Or use .splice(entryIndexNo, 1); with entryIndexNo as the entry position

Some details about Array.splice(entryIndexNo, howManyToRemove, entryDescriptionArray) (documentation):

• entryIndexNo - position of entry, start counting at zero
• howManyToRemove - number of entries to be removed. Set to zero to only add entries.
• entryDescriptionArray - array with description of a menu entry

How to write utf8 chars, like èåäö, in the context menu file?
A solution is to encode them yourself: Find your char at http://unicode.coeurlumiere.com, replace the last zero of the left code by the character in the upper row and prepend the result with \u : i.e. \u00E3 for 'ã'

In the releases before April 2013, you could fully customize those menus by editing these files in the 'jsmenu/' directory:

And to prevent to load the context menu, simply remove the indexmenu_contextmenu variable declared in the above menu files.

You can override styling from the style.css in order to globally customizing the tree menus style. Therefore you create (or extend) [wiki directory]/conf/userstyle.css with your own css. (See also css).

Some styles are:

If you want to apply a different style then the global one to a js theme, you need to create a style.css file like this inside the theme directory you want customize and use its name as subclass.

check if this example is still up-to-date. For example you could add for the 'thread' theme:

lib/plugins/indexmenu/images/thread/style.css

/*Custom style for the thread theme*/
 
.dtree.thread{
  font-family: Comic Sans MS;
}
 
.dtree.thread a.navSel {
  background-color: #000;
  color: #fff
}

Existing example for 'human.png' theme: style.css.

Note: in about June 2014 the css of some .dtree related stylesheet lines is changed. This can break your styling. Please use the latest version of indexmenu, and review your styles. A look at the CSS changeset could be useful.

• If you installed for the first time the indexmenu plugin or upgraded it from a previous release, it could be merely a cache issue. Example of symptoms are: tree is not displayed (or a static DokuWiki index is displayed in its place), context menu is not working, any new release feature reported in the changelog is working.
  Try to follow instructions to purge cache described in the The tree is not displayed section and retry to display it.
• When an updated indexmenu plugin fails in a 2013-05-10 “Weatherwax” release and later:
  Please check whether all plugins and your theme don't use the old javascript functions. Since the Weatherwax release, these deprecated functions are missing (some plugins still require an update) and will break the javascript rendering.
  Check for errors:
  - in console of browser e.g. as part of the Developer toolbar
  - by disabling all plugins and enabling one by one
• If you think that indexmenu are still not fitting your needs, be sure to using a correct syntax, and read carefully the configuration instructions. There are a lot of options for this plugin, maybe you missed the good one.
• You are sure that the syntax is correct. Perhaps you missed something in this FAQ and Notes section.
• Still no solution? Check if someone reported your issue at the Issue tracker.
• Okay, now I believe that indexmenu is really not working as needed. Please report a detailed bug at the Issue tracker, where you mentioned your syntax and configuration options and I'll try to find a solution in my spare time.

Follows these instructions:

1. To have installed an indexmenu release compatible with your DokuWiki version as described in how to install.
2. To have the last indexmenu version installed. For example check that its date is the same of changelog last release through the info button in plugin manager.
3. To have used a correct syntax.
4. To have purged CSS and JavaScript and more as cached by DokuWiki. Go to the Configuration Manager and just resave, to refresh this caching.
5. To have purged your browser cache. Use Ctrl + R or Ctrl + F5
6. When you try the javascript version of the indexmenu and it fails, please disable all the self-installed plugins check if now works. Nextly, you enable the plugins one-by-one to find the bad one.

If problem still persists, please, report the bug with details of your configuration in reporting_feature_requests_and_bugs section.

Check your ACL settings, please note that the user needs at least READ permissions to the page “sidebar”.

If your site contains a large amount of pages, and you're using indexmenu as a navigation sidebar, you could notice random slowdowns in the page loading.

This happens when cache is purged and the whole indexmenu tree has to be rebuilt.

To avoid this problem you may use the max option, which rebuilds only a single tree portion (sublevel) and enable AJAX for further user-requested sublevels.

I have in my sidebar the following code

{{indexmenu>:#1| js navbar id#random }}

and I get after saving this message: Indexmenu ID conflict. What's wrong?

A conflict happens when there are two indexmenu tree with the same ID in a web page.

When you just edited the sidebar page, your sidebar & your content page are the same, so its content is displayed twice. When it contains a indexmenu, this index is also shown twice. This is no problem because normally you don't visit the sidebar as normal wiki page.

When you have a sidebar defined a sidebar, but it is used as normal page too e.g. an index page, it is recommended to create a separate page for the index page. A separate page prevents displaying same index twice so they can not conflict anymore. The index page may have the same syntax options as the sidebar, but when you use id with a self defined id#identifier, your identifier must be different.

A workaround to get rid of the warning message, is to use the Nosidebar plugin to remove the sidebar on the sidebar page.

Yes, You can sort pages with the tsort, dsort or msort syntax options. To sort namespaces you need to add the nsort option to previouses.

1. Enable the sidebar function in your template. See FAQ sidebar for configuration and installing.
2. Add the indexmenu to the page used as sidebar.

Indexmenu provides only the index, for configuration of e.g. visibility of the sidebar itself you have to look in the features of the different sidebar solutions.

The tree is always immediately updated. So you have not to worry to use ~~NOCACHE~~ instruction, it's not useful and slows down the page loading.

To purge cache either wait for the automatic purge cache time expiration or force it through a purge=true request on the page that contains the indexmenu tree.

Every js indexmenu has an identifier (randomly generated by default) used by cookies to remember the current tree state (the selected, open and closed nodes). When the page cache expires or is purged, this information is reset because a new cookie (and consequently a new identifier) is generated.

This is not a problem because cache purge is not frequent, but if indexmenu is called inside an uncached page or directly inside PHP code, every time an user loads the page, indexmenu behaviour is to not remember its previous state just like when nocookie is defined.

In this case, the solution is to force a permanent identifier through the id#identifier option. The identifier can be any number or the string “ns”. The last option is used in rare case, because it will generate an ID based on the chosen main namespace. It's important to have unique ids in your site because two menus with the same identifier will interfere with each other when the user opens or closes nodes.

Create your own arrow in GIF format with an image editor, then override the default one in dokuwiki/lib/plugins/indexmenu/images/scrollleft.gif. Change the height and width of the .indexmenu_arrow property in the Css Style according to the size of your image.

You could need a browser cache purging.

The name of the graphic is no longer scrollleft.gif, but now toc_bullet.gif. To ensure that the changes are not lost during an update, it is better to make an entry in /dokuwiki/conf/userstyle.less. For example, the graphic disappears as follows: .dtree .indexmenu_tocbullet {background: transparent;} Or you can insert another graphic as follows: .dtree .indexmenu_tocbullet {background: transparent url(path_to_the_graphic/graphic.gif) no-repeat scroll;}

First of all, you could need to correctly set the Acl cache option in order to avoid displaying of denied pages.

Indexmenu tree behaviour depends also on the sneaky_index option in this way:

• Enabled: if namespace is denied, it stops its recursive search on that namespace branch even if there are authorized pages or namespaces below it.

• Disabled: Indexmenu doesn't stop its recursive search and it could show denied namespaces (NOT pages).

In both cases, unauthorized pages are never showed. There are also some issues About empty namespaces that should be read.
This namespace behaviour in presence of ACLs can not be changed until it's not changed in the DokuWiki core itself.

Example:

+-Mysite         (ns) (allowed)
 +-private       (ns) (denied)
   +-ppublic     (ns) (allowed)
     -ppstart    (page) (allowed)
   -pstart       (page) (denied)
 +-public        (ns) (allowed)
   -linux        (page) (allowed)
 +-public2       (ns) (allowed)
   -secret       (page) (denied)
 -start          (page) (allowed)
 -start2         (page) (denied)

Enabled will display:

+-Mysite         (dir)
 +-public        (dir)
   -linux        (page)
 +-public2       (dir **displayed only in case of any sort option**)
   -X           (empty/unauthorized icon **displayed only in case of any sort option**)
 -start          (page)

Disabled will display:

+-Mysite         (dir)
 +-private       (dir)
   +-ppublic     (dir)
     -ppstart    (page)
 +-public        (ns)
   -linux        (page)
 +-public2       (dir **displayed only in case of any sort option**)
   -X           (empty/unauthorized icon **displayed only in case of any sort option**)
 -start          (page)

Empty namespace can occur when:

• All its pages were deleted. DokuWiki never does really remove empty namespaces as it stores them as file system directories.
• All its pages and namespaces are skipped by skip namespaces in index or skip files in index options.
• All its pages and namespaces are denied to users by ACLs settings.
• It has got only a child page, this page is its headpage and hide_headpage option is enabled.

When the max#nr option or level of folded nodes are configured and the node has to retrieve its children through the Ajax request, there can appear empty nodes because indexmenu hasn't looked forward and doesn't know yet that the node was empty.

Why do you need a sort option to correctly hide empty namespaces?
When any of the sort options tsort, dsort, msort nsort or hsort is used indexmenu replaces the faster, but less featured, core DokuWiki search with the slower, but more featured, indexmenu search that filters more empty nodes.

Why will sneaky_index hide forbidden namespaces
Enabling the sneaky_index also checks for access to forbidden namespaces, instead of only checking access to pages. This means that it hides deeper allowed pages or namespaces as well. These nodes aren't reachable via the index anymore.. See also About ACLs.

The text used for the nodes in the tree is retrieved from DokuWiki's metadata store. DokuWiki uses a background process triggered by a web-bug to updating this metadata.⁷⁾ If you added wiki pages/namespaces via the filesystem (rather than creating them in DokuWiki,) and that page/namespace has never been viewed, the metadata will not have been generated.

Please refer to https://github.com/samuelet/indexmenu/issues to share your feature requests and bug reports.

See also for additional info:

• FAQ and notes
• and Discussion page

Please, use the discussion page for feature requests and general discussion.
Old discussions are archived in the olddiscussion page.