Show a tree menu for a namespace
Compatible with DokuWiki
2008-05-05
Show a tree menu for a namespace
This extension has not been updated in over 2 years. It may no longer be maintained or supported and may have compatibility issues.
Similar to alphaindex, indexmenu, tindexmenu
This plugin shows the index menu for a namespace. Its core features:
ns/ns.txtns.txtns/<start_page>.txtValues in square brackets are optional.
{{indexmenu>namespace[#[n][+nons]][#sort+[!]<sort_type>] [|js[#[theme][+ajax]]]}}
| Option | Description | Comments | Req/Opt |
|---|---|---|---|
| namespace | Namespace name from which the index starts. | Take a look at namespaces for the complete reference. | required |
| n | Number that specifies the max level of the tree index nodes. | With nons means the max depth of the pages to put in list. | optional |
| nons | Exclude namespaces nodes from index. | When set, only pages are included in the index. | optional |
| sort | Enable sorting | Indicates that menu should be sorted by the sort_type parameters | optional |
| sort_type | One of the following: | fn - filename title - page heading date file creation date. ! - exclamation mark in front of the sorting mode means reversed sort. | optional |
| js | Use JavaScript to add fancy dynamic stuff to the menu | [n] keeps its meaning | optional |
| theme | Skin name for indexmenu2, when in js mode. | a theme is a set of CSS files and icons inside plugins/indexmenu/templates/DokuWiki/<skin> | optional |
| ajax | Enables Ajax-driven index | When set, submenus below [n] level will be taken from the server using Ajax | optional |
Example that display a JavaScript Index tree menu with nodes open till second level:
{{indexmenu>wiki:plugins#2|js}}
The same, when used on the wiki page
{{indexmenu>:plugins#2|js}}
Wiki theme for js option.
{{indexmenu>wiki:plugins|js#DokuWiki}}
Standard Dokuwiki index showing only pages inside wiki:plugins and lower namespaces (max two levels):
{{indexmenu>wiki:plugins#2|nons}}
Use 'IndexMenu' theme and build submenus below 2nd level using Ajax calls.
{{indexmenu>wiki:plugins#2|js#IndexMenu+ajax}}
Use 'IndexMenu' theme and build submenus below 2nd level using Ajax calls. Sort it by the page title in reversed order.
{{indexmenu>wiki:plugins#2#sort+!title|js#IndexMenu+ajax}}
In general, options are equal to syntax_for_indexmenu, but it use only js, theme and ajax.
Note:
This example shows the general usage:
<navigation |js#IndexMenu+ajax>
this text will be removed, because it stay outside the menu
* [[http://somesite| Some internet site]]
* [[http://somesite/someurl| Interesting URL on some site]]
* [[http://somesite/someimage| {{http://somesite/someimage}}]] - image from some site
* just a text, it won't act as a link
* [[here should be a link to make submenu collapsible]]
* no need to put anchors here
* but, does it make a sense to create submenu without a links?
* {{indexmenu>:#2#sort+title+rev|js}}
</navigation>
In this release, Indexmenu2 utilizes the global $conf['plugin_indexmenu'] options array.
Array keys: hide_headpage - is kept as is. skip_index - new option. It is regular expression, describes what pages and namespaces will be removed from the index. Suggested option is:
#\/(discussion|wiki|playground)(\.\w+)?$#i
empty_message - message that will be printed, when no index is available
Use the built-in configuration manager.
Showing the namespace title is controlled by global DokuWiki's option useheading.
JavaScript menu is implemented using The Complete Menu Solution code, adapted to DokuWiki standards.
Creation of new themes is slightly harder than in original indexmenu, but much more flexible.
To create new skin follow next steps:
indexmenu/templates/DokuWiki/, f.e. NewSkinindexmenu/templates/DokuWiki/NewSkin folderOk, new skin is done. Now you can update images or alter CSS definitions for your skin.
For more detailed info check the datasheet.
Use your skin with js#NewSkin syntax, remember - skin name is case sensitive.
Distribution contain 3 themes:
Search and install the plugin using the Extension Manager.
Alternatively, refer to Plugins on how to install plugins manually. Download the indexmenu.zip file and unpack it into lib/plugins folder. Caching can be expired by resaving the Configuration Manager.
Bugs are moved to bugs
I don't know if i do that correctly with this here…
So, Hi at first, I've installed that indexmenu2. monobook is also on my wiki… so my problem is, that the index menu (at the right side, that thing that show all nodes in the article (H1, H2, H3…) hasn't the correctly text align. so when it is expanded, the text isnt at the right side, it beginns at the end of the indes. when i collaps it, it's the same problem. You understand me?
Is that a bug, or a incorrect file?
Bugtracker is available.
Hi. I wanted to hide 'archived' pages. But I don't like to rename or move pages. So I added the following code in syntax.php:
//Set title and link if (!$conf['useheading'] || !$title=p_get_metadata($id,'title')) $title=noNS($id); // hide titles starting with an # ... if( $title[0] == '#' ) return false; // $title=htmlspecialchars($title,ENT_QUOTES); $link=wl($id);
So, I can hide a page by editing the first heading. – Christoph Purrucker, 2007-06-26
The functionality provided by the navigation component is now also available in the indexmenu plugin. See http://www.ceng.metu.edu.tr/~ahmet/Mektep/index.php?id=mektep:plugins&serveplugin_help=indexmenu. — Ahmet Sacan 2009/09/20
Unfortunately, this plugin is not compatible with version “Adora Belle” of dokuwiki, released in october 2012. Instead of the tree of folders, only an icon shows up. Resolution for me: Use the indexmenu. – KaiMartin 2012/10/28