Arguments inside ”[]” parenthesis are optional:
{{indexmenu>[namespace[#n]] [ns1[#n] ... nsn[#n]] | [js[#theme]] [tsort] ...}}
Settings before the “|” separator:
| Option | Action | Comment |
|---|---|---|
namespace | Main namespace name. Index starts from it. | Optional with n or nons; “.” is the current namespace; ”..” or an empty value shows the root site namespace; ”.:ns1” is the ns1 namespace inside current namespace. |
n | Number that specifies, in js mode, the tree level to open, while, in nojs mode, it is the max level to show. | Optional; it can be used together with nons. Not defined opens all nodes, whereas equal to 0 or 1 closes them. |
ns1[#n] ... nsn[#n] | A list of optional namespaces inside main namespace. Every namespace will be opened or closed at the specified n level. | Optional. It can be used together with nons. Not defined n opens all nodes, whereas equal to 0 closes them. |
Settings after the “|” separator:
| Option | Action | Notes |
|---|---|---|
js | Javascript render method: the index is an expandable tree menu. | Optional; without n, all nodes are open, with it, nodes are open till n level. |
nons | Exclude namespaces nodes from index. It shows only the pages. | Optional. |
tsort | Sort pages by title. | Useful when useheading is on. Optional. |
dsort | Sort pages by date creation. | Optional. |
msort[#meta] | Sort pages by a custom metadata information. Without the optional meta parameter, it'll be used the custom sorting number specified with the {{indexmenu_n>N}} syntax (read below for more info). meta should refer to the data structure (Array values are managed throught the ”:” separator, for example: “msort#date:modified). | You can use the tsort/dsort option togheter with msort in order to sort pages without metadata tag in a different way from the default Dokuwiki one (sorted by page name). Optional. |
rsort | Reverse the sorting of pages. | Optional. |
nsort | Sort also namespaces according to the previous sort options. | Optional. |
max#n[#m] | The node at n level will retrive all its childs nodes through the ajax mechanism. Optionally, instead of retrive them in one time, it can retrives them with ajax every m sublevels. | Optional. Cookie are automatically disabled, just like with noocookie. It affects the server loading and speeds up the loading of page in dokuwikis with an high amount of pages. It works only in js |
navbar | The tree opens itself automatically at the current page namespace. It's good as navigation sidebar. | ATTENTION: It also sets id=1, therefore use only one navbar indexmenu in you site or set manually different id for other navbar trees. It works only in js |
theme | Theme name for indexmenu icons | A theme is a set of icons inside images directory as described in Theme tutorial. Admins can download and share themes in admin panel. It works only in js |
id[#random|n] | Cookie id for a js indexmenu. By default is random, but you can force it to be a n fixed number ( i.e id#20 ). | Useful only when you need two or more navbar tree or when a page is uncached and you don't use the nocookie option. Read the Js does not remember its prevous state section. ATTENTION: id must be unique for every indexmenu in your dokuwiki site or you'll get strange js behaviors. It works only in js |
maxjs#n | It sets how many js tree levels to render when page loads. Remaining nodes are rendered (slightly slower) only when they are open by users, by optional namespaces option, by cookies or by navbar option. | Default n is 1 so that it will speed up the page loading, above all with an high amount of pages. It affects only the user-client cpu speed, not the webserver load. It works only in js |
nocookie | By default js indexmenu remember selected,open and closed nodes by user during navigation. With this option it doesn't remember them and the tree is blocked to its start status. | It works only in js |
noscroll | Disable the javascript scrolling feature. It could solve visualization problems. | It works only in js |
notoc | Disable the toc-preview feature. | It works only in js |