Differences

This shows you the differences between two versions of the page.

--- plugin:indexmenu [2016-02-29 10:24] – 14.215.134.131
+++ plugin:indexmenu [2024-02-08 00:38] (current) – Klap-in
@@ Line 1: / Line 1: @@
-==== Socket代理协议说明 ====
+====== IndexMenu Plugin ======
-香港棋牌客户端请求PHP接口方式，由客户端发接口给Socket Server，Socket Server转发给PHP，PHP处理完毕返回结果给Socket Server再转回给客户端。
+---- plugin ----
+description: Show a customizable and sortable index for a namespace
+author     : Samuele Tognini, Gerrit Uitslag
+email      : samuele@samuele.netsons.org
+type       : syntax,action
+lastupdate : 2024-01-05
+compatible : !Greebo, !Hogfather, Igor, Jack Jackrum, Kaos
+depends    :
+conflicts  : indexmenu2
+similar    : alphaindex, indexmenu2, navi, simplenavi
+tags       : navigation, menu, listing, namespace, index
-【客户端】 <---- 长连接 ----> 【Socket Server】 <.... 短连接 ....> 【PHP】（半透明转发协议）
+sourcerepo : https://github.com/samuelet/indexmenu
+bugtracker : https://github.com/samuelet/indexmenu/issues
+downloadurl: https://github.com/samuelet/indexmenu/archive/master.zip
+donationurl: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=102873
+----
-地方棋牌PHP在使用标准REST接口的基础上，接收返回数据时做了处理，以保证接口完全兼容新版斗地主的协议。下面对兼容前后的请求方式举例说明。
+^ :!: Since December 2023 two JavaScript trees are available for Indexmenu's option 'js'. For the (still) default js tree ''js treeold'' you have to disable the [[config:defer_js|defer_js feature flag]]. For the new ''js treenew'' you can enable deferred JavaScript loading again.\\ \\ To enable the new js tree for all trees, add ''treenew'' to the ''defaultoptions'' setting in the Configuration Manager.\\ \\ Note that the contextmenu (and ToC) are not supported for the new tree, please vote in: [[https://github.com/samuelet/indexmenu/issues/230|issue #230]] ^
-REST请求(POST源内容)：
+===== Description =====
-REST返回:(如请求数据中存在字段“compatible”则返回结果格式则与半透明转发时一致)
+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]].
-<pre>{"code":200,"error":"","result":{"mid":2,"app_id":103000,"reg_time":1388109996 ... }}</pre>
+Main features are:
+  * Fully customizable with a lot of [[.:indexmenu#syntax|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 [[.:indexmenu#JavaScript themes]].
+  * Assign [[.:indexmenu#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 [[.:indexmenu#The context menu|context mouse menu]] for usual namespace/page actions.
+  * TOC pages preview.
+  * [[.:indexmenu#page_index|Replace]] the DokuWiki page index.
+  * Hide namespaces/pages according to [[ACLs]] and plugin [[.indexmenu#skip_index|settings]].
-===== Socket代理协议说明 =====
+Themed indexmenu based on the Javascript index builder:\\
+{{http://samuele.netsons.org/dokuwiki/media/indexmenu1.jpg}}\\
+Indexmenu based on Dokuwikis index builder:\\
+{{http://samuele.netsons.org/dokuwiki/media/indexmenu2.jpg}}
-<pre>m=hand&p=out&act=1&index=2&cmd=1&info={"mid":1,"php":"{\"cmd\":1,\"seq\":13982343234,\"app\":103000,\"ssid\":\"sdfsdfd2cc3dssfd2\",\"action\":\"user.getuifno\",\"__debug\":0}"}</pre>
+  * You can test it at the playground page of the [[http://samuele.netsons.org/dokuwiki/doku.php?id=dokuwiki:plugins:indexmenu|indexmenu web site]].
-''使用POST传参，'''m、p、act、index、info.mid'''均为Socket Server添加的兼容字段，客户端发送的源数据被添加到了'''info.php'''字段中(JSON中包含的JSON)，并且客户端多加了'''cmd'''字段和'''seq'''字段用于自身处理。''
+  * Thanks to Geir Landrö and his JavaScript [[http://www.destroydrop.com/javascripts/tree/|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 [[.:indexmenu:discussion]] page).
+  * Feel free to [[.:indexmenu#development|improve]] it.
-'''cmd''': 用于标识命令，返回时原样返回
-'''seq''': 请求标识请求，返回时原样返回(建议客户端为每一个php请求分配一个不同序列号，收到返回结果时根据本字段区分对应请求)
+===== Donation =====
-'''__debug''': 用于指示PHP记录下用户请求数据与返回结果，用于跟踪用户请求定位问题，每次启动应用需要客户端将值设置为0，有需要时告知用户打开客户端的开关，将该值修改为1，但下次启动依旧需要清0。
+The indexmenu plugin is not sponsored by anyone but I develop and support it for free during my spare time.
-===== Socket代理协议说明 =====
+If you want to offer me a friendly beer (({{https://upload.wikimedia.org/wikipedia/commons/thumb/8/82/Tennent%27s_77.JPG/180px-Tennent%27s_77.JPG}})), you can consider to make a [[http://samuele.netsons.org/dokuwiki/doku.php?id=dokuwiki:plugins:indexmenu#donation|donation]].
-'''半透明转发返回：'''
+====Examples:====
-<pre>{"status":0,"type":0,"msg":"","cmd":1,"seq":13982343234,"info":{"mid":2,"app_id":103000,"reg_time":1388109996 ... }}</pre>
+|Root namespace. Expands all |''%%{{indexmenu>:}}%%'' |
-''REST接口中的'''code'''字段演变为了'''status'''和'''type'''两个字段，'''error'''改名为'''msg'''，'''result'''改名为'''info'''，客户端发送过来的'''cmd'''字段和'''seq'''字段追加到结果中以便客户端区分返回的结果属于哪个接口。''
+|Current namespace. Expands all |''%%{{indexmenu>.}}%%'' |
-==== Socket代理协议说明 ====
+|Current namespace. Show only current level, don't expand any nodes. |''%%{{indexmenu>.#1}}%%'' |
-asdadasdad
+|Parent namespace. Show parent namespace ("uplink") and current level, don't expand any nodes. |''%%{{indexmenu>..:#1}}%%'' |
-===== Socket代理协议说明 =====
+|''wiki'' namespace, expand containing namespaces, not subnamespaces.\\ Using the themed Javascript indexmenu. |''%%{{indexmenu>:wiki#1|js}}%%'' |
-==== Socket代理协议说明 ====
-香港棋牌客户端请求PHP接口方式，由客户端发接口给Socket Server，Socket Server转发给PHP，PHP处理完毕返回结果给Socket Server再转回给客户端。
+====== Syntax ======
-【客户端】 <---- 长连接 ----> 【Socket Server】 <.... 短连接 ....> 【PHP】（半透明转发协议）
+**Basic syntax usage:**
-地方棋牌PHP在使用标准REST接口的基础上，接收返回数据时做了处理，以保证接口完全兼容新版斗地主的协议。下面对兼容前后的请求方式举例说明。
+^ Main                                                         ^ Options                                                       ^
+| **%%{{%%indexmenu>ns[#n]** <sub>[ns1[#n] ns2[#n] ...]</sub>  | **%%|%%** //<sub>[js[#theme]] [tsort] ...</sub> //**%%}}%%**  |
+Arguments inside ''[]'' parenthesis are optional. The ''#'' char is always required with related options.
-REST请求(POST源内容)：
+:!: All the syntax options can be easily accessed with the indexmenu picker in the [[:edit window]] [[:toolbar]].
-REST返回:(如请求数据中存在字段“compatible”则返回结果格式则与半透明转发时一致)
-<pre>{"code":200,"error":"","result":{"mid":2,"app_id":103000,"reg_time":1388109996 ... }}</pre>
-===== Socket代理协议说明 =====
+**Minimum syntax:**
-<pre>m=hand&p=out&act=1&index=2&cmd=1&info={"mid":1,"php":"{\"cmd\":1,\"seq\":13982343234,\"app\":103000,\"ssid\":\"sdfsdfd2cc3dssfd2\",\"action\":\"user.getuifno\",\"__debug\":0}"}</pre>
+''%%{{indexmenu>.}}%%'', ''%%{{indexmenu>:}}%%'' or ''%%{{indexmenu>|}}%%''.
-''使用POST传参，'''m、p、act、index、info.mid'''均为Socket Server添加的兼容字段，客户端发送的源数据被添加到了'''info.php'''字段中(JSON中包含的JSON)，并且客户端多加了'''cmd'''字段和'''seq'''字段用于自身处理。''
+That means this ''%%{{indexmenu}}%%'' and this ''%%{{indexmenu>}}%%'' do not work.
-'''cmd''': 用于标识命令，返回时原样返回
-'''seq''': 请求标识请求，返回时原样返回(建议客户端为每一个php请求分配一个不同序列号，收到返回结果时根据本字段区分对应请求)
+===== Full syntax =====
-'''__debug''': 用于指示PHP记录下用户请求数据与返回结果，用于跟踪用户请求定位问题，每次启动应用需要客户端将值设置为0，有需要时告知用户打开客户端的开关，将该值修改为1，但下次启动依旧需要清0。
+Settings **before the "|"** separator:
-===== Socket代理协议说明 =====
+^Main ^Action ^Note|
+^ //''ns''//     | //**Main namespace**// name. Index starts from here. Syntax complies with DokuWiki [[:namespaces#creating namespaces|namespaces]] paths.| "**.**" refers to the namespace of the page containing the indexmenu syntax and **not** to the current DokuWiki namespace context ((the namespace of the page displayed by a user who is navigating your site)) (see the **//context//** option for this feature). "**:**" or an empty value shows the root site namespace.|
+^ //''#n''//             | **n** is a number that specifies how many namespace levels to display open under the //**main namespace**//.| If it's not defined then the whole tree, till the deeper node, will be open. If ''//0//'' or ''//1//'' it'll display only nodes under the main namespace. For example: "#2" will display "root:myns1:myns2" but will keep myns2 closed thus hiding "root:myns1:myns2:myns3". Optional.|
+^ //''ns1[#n] %%...%% nsn[#n]''// | A list //**of optional namespaces**// inside the //**main namespace**//. Every namespace will be opened or closed at the specified //**n**// level. Syntax complies with DokuWiki [[:namespaces#creating namespaces|namespaces]].| If **n** is not defined then all namespaces are open, if ''//0//'' they are closed. "**.**" refers to the namespace of the page containing the indexmenu syntax and **not** to the current DokuWiki namespace context ((the namespace of the page displayed by a user who is navigating your site)) (see the **//context//** option for this feature). "**:**" or an empty value shows the root site namespace. Optional.|
-'''半透明转发返回：'''
+Optional settings **after the "|"** separator (separated by spaces):
-<pre>{"status":0,"type":0,"msg":"","cmd":1,"seq":13982343234,"info":{"mid":2,"app_id":103000,"reg_time":1388109996 ... }}</pre>
+^Option ^Action ^Note|
-''REST接口中的'''code'''字段演变为了'''status'''和'''type'''两个字段，'''error'''改名为'''msg'''，'''result'''改名为'''info'''，客户端发送过来的'''cmd'''字段和'''seq'''字段追加到结果中以便客户端区分返回的结果属于哪个接口。''
+^ ''js'' \\ undo: ''nojs''          | JavaScript render method: the index is an expandable tree menu. Without the ''js'' option DokuWikis index renderer is used | Without //**n**//, all nodes are open, with it, nodes are open till //**n**// level.|
-==== Socket代理协议说明 ====
+^ //''#theme''// \\ undo: ''#default''          | Theme name for indexmenu icons | A theme is a set of icons inside ''//images//'' directory as described in [[.:indexmenu#Theme tutorial]]. Admins can download and share themes in admin panel. It works only in //**js**// e.g. //**js#tango**// |
-asdadasdad
+| Next options are available with or without //**js**// option. |||
-===== Socket代理协议说明 =====
+^ ''navbar'' \\ undo: ''nonavbar''         | The tree opens itself automatically at the current page namespace. Useful in a navigation sidebar.| Without //**js**// option, the indexmenu page is never cached (just like the default DokuWiki index page) and the DokuWiki loading could be slower depending on the amount of child nodes displayed. |
+^ ''context''  \\ undo: ''nocontext''   | [[:namespaces#creating namespaces|Relative]] //**main namespace**// and //**optional namespaces**// will refer to the current DokuWiki namespace context ((the namespace of the page displayed by a user who is navigating your site)) instead of to the namespace of the page containing the indexmenu syntax. Useful in a navigation sidebar.| The indexmenu page is now never cached so the DokuWiki loading could be slower depending on the amount of child nodes displayed (In //**js**// mode, when a lot of nodes are usually displayed, the //''max''// option is recommended). It automatically enable the //**nocookie**// option.|
+^ ''tsort''   \\ undo: ''notsort'' | Sort (only) pages by title. | Useful when [[config:useheading]] is on. By default namespaces are **not** sorted, you need the **//nsort//** option for this.|
+^ ''dsort''   \\ undo: ''nodsort''  | Sort (only) pages by date creation (first the oldest). | By default namespaces are **not** sorted, you need the **//nsort//** option for this.|
+^ ''msort[#meta]''   \\ undo: ''nomsort''  | Sort (only) pages by a custom [[:devel:metadata]] information. Without the ''#meta'' parameter, i.e. ''msort'', it looks for the custom sorting number specified with the ''%%{{indexmenu_n>N}}%%'' syntax  (see the below [[.indexmenu#metadata tag syntax]]).\\ With ''#meta'' parameter you can refer to the [[:devel:metadata#data structure|meta data structure]] (Array values are managed through the ":" separator, for example: ''msort#date:modified''). |By default, pages without metadata tag are sorted by page name (the default DokuWiki way), but you can override this behaviour adding also the tsort or dsort option in the indexmenu syntax. By default namespaces are **not** sorted, you need the **//nsort//** option for this.|
+^ ''hsort''   \\ undo: ''nohsort'' | Sort the headpages as defined by config setting [[config:startpage]] to the top |msort overrules hsort |
+^ ''rsort''   \\ undo: ''norsort'' | Reverse the sorting of pages (change between ascending and descending). |By default namespaces are **not** sorted, you need the **//nsort//** option for this. |
+^ ''nsort''   \\ undo: ''nonsort'' | Also sort namespaces according to page sort options together with the pages (not grouped separately anymore since January 2024). | To use in //addition// to the above sort options. tsort, dsort, msort, hsort apply only for namespaces when using [[#namespaces_title_and_link_headpages|headpages]]. rsort is applicable always together with nsort.  |
+^ ''nogroup'' \\ undo ''group'' | If ''nsort'' is used, ''nogroup'' mixes namespaces and pages to sort them together | |
+^ ''nons''   \\ undo: ''ns''  | Exclude namespaces nodes from index. It shows only the pages. | Without **//js//**, the closing **//n//** namespace option prevents to display nodes below the **//n//** namespace level.|
+^ ''nopg''  \\ undo: ''pg''  | Exclude pages nodes from index. It shows only the namespaces. | All namespace nodes will link to the start pages (as defined by [[config:startpage]] setting) |
+^ ''skipfile[+|=]/regexp/'' | Skip files matching the regexp. | ''skipfile**+**/../'' skips files defined with this regexp additional to [[#skip_files_in_index|global skip]] config. ''skipfile**=**/../'' replace the global skip config with regexp from this syntax. See the global config explanation for some regexp [[#skip_namespaces_in_index|examples]].|
+^ ''skipns[+|=]/regexp/'' | Skip namespaces matching the regexp. | Just like skipfile, but [[#skip_namespaces_in_index|namespaces]].|
+| Next options are //only// available with //**js**// option -- with ''treeold''.\\ \\ **Default ''dTree'' based tree is shown. Deprecated. Will be changed in future to ''treenew''.** |||
+^ ''max#n//[#m]//'' \\ undo: ''nomax''  | If initially closed, the node at //**n**// level will retrieve all its child nodes through the AJAX mechanism when opened for the first time. Optionally, the nodes after the //**n**// level can be retrieved with AJAX every //**m**// sublevels instead of in one go.| It affects the server loading and speeds up the loading of pages in DokuWiki with an high amount of pages. It works only in //**js**//. Cookie are automatically disabled, just like with //**nocookie**//. |
+^ ''maxjs#//n//''  \\ undo: ''nomaxjs''   | 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**// |
+^ ''id#[random|ns|//number//]''   \\ undo: ''id#random''     | [[wp>HTTP_cookie|Cookie]] Identifier for a js indexmenu where the previously opened/closed nodes by a user are stored. | Useful when a page is uncached and you like the tree state is stored in cookie. (See //**nocookie**// for disabling cookies.)  Default the option ''//id#random//'' is active, also when the option is not specified in the syntax. You can apply self a number as unique identifier for your indexmenu  ( e.g. ''//id#20//'' ) or let generate a number unique for requested namespace with ''//id#ns//''. Read the [[.:indexmenu#Js does not remember its previous state]] section. **ATTENTION:** ID must be unique for every indexmenu in your DokuWiki site or you'll get strange js behaviors. Tree state storage with cookie only in //**js**// |
+^ ''nocookie''  \\ undo: ''cookie'' | Disable [[wp>HTTP_cookie|cookies]]. 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. | Tree state storage with cookie only in //**js**//|
+^ ''noscroll''   \\ undo: ''scroll''    | Disable the JavaScript scrolling feature when it doesn't fit the container width. It could solve visualization problems. | It works only in //**js**//|
+^ ''notoc''  \\ undo: ''toc''        | Disable the TOC-preview feature. | ToC preview only available in //**js**//|
+^ ''nomenu''  \\ undo: ''menu''       | Disable the contextmenu feature. | Context menu only available in //**js**//|
+| \\ Next options are //only// available with //**js**// option -- with ''treenew''. \\ \\ **Temporary: extra option ''treenew'' shows a Fancytree based tree. Will become the default in the future.**  |||
+^ ''max#n//[#m]//'' \\ undo: ''nomax''  | For the initially closed nodes, it will retrieve all its child nodes up to //**n**//th level through the AJAX mechanism. Optionally, the nodes after the //**n**//th level can be retrieved with AJAX every //**m**//th sublevels instead of per 1 level. The number of opened levels is set behind the namespace, see main settings above.| It affects the server loading and speeds up the loading of pages in DokuWiki with an high amount of pages. It works only in //**js**//. |
-==== Socket代理协议说明 ====
-香港棋牌客户端请求PHP接口方式，由客户端发接口给Socket Server，Socket Server转发给PHP，PHP处理完毕返回结果给Socket Server再转回给客户端。
+===== Temporary multiple js trees =====
+The js option uses so far the JavaScript [[http://www.destroydrop.com/javascripts/tree/|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.
-【客户端】 <---- 长连接 ----> 【Socket Server】 <.... 短连接 ....> 【PHP】（半透明转发协议）
+To replace it, the JavaScript [[https://wwwendt.de/tech/fancytree/demo/|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 ''newtree'' to the ''defaultoptions'' setting in the Configuration Manager.
-地方棋牌PHP在使用标准REST接口的基础上，接收返回数据时做了处理，以保证接口完全兼容新版斗地主的协议。下面对兼容前后的请求方式举例说明。
+===== Examples =====
-REST请求(POST源内容)：
+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:
+<code>
+{{indexmenu>:#1|js navbar nocookie}}
+</code>
-REST返回:(如请求数据中存在字段“compatible”则返回结果格式则与半透明转发时一致)
+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 [[.indexmenu#Metadata tag syntax|custom sort]] number:
+<code>
-<pre>{"code":200,"error":"","result":{"mid":2,"app_id":103000,"reg_time":1388109996 ... }}</pre>
+{{indexmenu>:#1|js#thread navbar max#3#2 tsort msort}}
+</code>
-===== Socket代理协议说明 =====
+Standard DokuWiki index showing only pages inside wiki:plugins and lower namespaces (max two levels):
+<code>
+{{indexmenu>:wiki:plugins#2|nons}}
+</code>
-<pre>m=hand&p=out&act=1&index=2&cmd=1&info={"mid":1,"php":"{\"cmd\":1,\"seq\":13982343234,\"app\":103000,\"ssid\":\"sdfsdfd2cc3dssfd2\",\"action\":\"user.getuifno\",\"__debug\":0}"}</pre>
+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 [[.:indexmenu#Namespaces title and link (headpages)|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:
-''使用POST传参，'''m、p、act、index、info.mid'''均为Socket Server添加的兼容字段，客户端发送的源数据被添加到了'''info.php'''字段中(JSON中包含的JSON)，并且客户端多加了'''cmd'''字段和'''seq'''字段用于自身处理。''
+<code>
+{{indexmenu>:archive#1|js tsort nsort rsort}}
+</code>
-'''cmd''': 用于标识命令，返回时原样返回
+Standard index showing the tree of the current context((the namespace of the page displayed by a user who is navigating your site)) opened at the second level.
+<code>
+{{indexmenu>playground#2|context}}
+</code>
-'''seq''': 请求标识请求，返回时原样返回(建议客户端为每一个php请求分配一个不同序列号，收到返回结果时根据本字段区分对应请求)
+Show all current namespace pages.
+<code>
+{{indexmenu>.:#1|context}}
+</code>
-'''__debug''': 用于指示PHP记录下用户请求数据与返回结果，用于跟踪用户请求定位问题，每次启动应用需要客户端将值设置为0，有需要时告知用户打开客户端的开关，将该值修改为1，但下次启动依旧需要清0。
+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.
-===== Socket代理协议说明 =====
+<code>
+{{indexmenu>private|js nopg dsort}}
+</code>
-'''半透明转发返回：'''
-<pre>{"status":0,"type":0,"msg":"","cmd":1,"seq":13982343234,"info":{"mid":2,"app_id":103000,"reg_time":1388109996 ... }}</pre>
+==== Metadata tag syntax ====
-''REST接口中的'''code'''字段演变为了'''status'''和'''type'''两个字段，'''error'''改名为'''msg'''，'''result'''改名为'''info'''，客户端发送过来的'''cmd'''字段和'''seq'''字段追加到结果中以便客户端区分返回的结果属于哪个接口。''
-==== Socket代理协议说明 ====
+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:
-asdadasdad
+<code>
-===== Socket代理协议说明 =====
+{{indexmenu_n>N}}
+</code>
+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 [[config:useheading]] pages:
+<file>
+-Root
+  |_don
+  |_Mirror sessions         (headline title of the ":mirror" page)
+  |_pachuco
+  |_At the radar station    (headline title of the ":radar" page)
+  |_van
+  |_vliet
+</file>
+in this way:
+<code>
+{{indexmenu>:#1|msort}}
+</code>
+<file>
+-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)
+</file>
+Pages without sort number, like the last three pages, are sorted by page name as default, but you can force a different sort:
+<code>
+{{indexmenu>:#1|tsort msort}}
+</code>
+<file>
+-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
+</file>
+====== Configuration options======
+Indexmenu is fully configurable from [[plugin:config|Configuration Manager]]. Options are explained in the below sections.
+==== Default options=====
+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.
+==== Only admins ====
+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.
+==== ACL Cache ====
+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 [[.:indexmenu#about ACLs]] and [[.:indexmenu#about_empty_namespaces]] that affects trees limited by ACLs.
+==== Namespaces title and link (headpages) ====
+== Titles for page headings ==
+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 [[config:useheading]] on in the general configuration of the wiki. Indexmenu will show page titles when useheading is 'always' or 'navigation'.
+== Title for namespaces headings ==
+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:
+^Value  ^Page  ^Example ^
+|**any value** | The page inside the namespace | public(ns):myvalue(page) |
+|**:inside:** | a page with the same name of namespace, beneath the namespace | public(ns):public(page) |
+|**:same:** | a page with the same name of namespace, at the same level of the namespace | public(page) <=> public(ns) |
+|**:start:** | the global [[config:startpage|start]] page name inside the namespace| public(ns):start(page) |
+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.
+== Hide headpages in tree ==
+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.
+==== Page index ====
+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:
+<code>
+{{indexmenu>:|navbar}}
+</code>
+or
+<code>
+{{indexmenu>:|js navbar nocookie}}
+</code>
+You may also want to hide this page in any indexmenu trees with the [[.:indexmenu#skip files in index]] option.
+==== Empty message ====
+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.
+==== Skip Namespaces in Index ====
+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 [[http://www.php.net/manual/en/reference.pcre.pattern.syntax.php|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 [[.:indexmenu#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
+<code>
+/(copyright|privatens:users)/
+</code>
+Skip the namespace whose ID is exactly ''myusers:spaces''. Here the characters ''^'' and ''$'' marks the start and the end of the matched string.
+<code>
+/^myusers:spaces$/
+</code>
+==== Skip Files in index====
+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 [[http://www.php.net/manual/en/reference.pcre.pattern.syntax.php|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 [[.:indexmenu#About empty namespaces]] that should be read.
+==== Show sort ====
+If you sorted a page with the [[.:indexmenu#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.
+====== How to install ======
+Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.
+Alternative download link: http://samuele.netsons.org/dokuwiki/media/indexmenu.zip
+[[http://samuele.netsons.org/dokuwiki/doku.php?id=dokuwiki:plugins:indexmenu#old_releases|Old releases]]
+===== Changelog =====
+|:!: You could need to purge your browser and server cache after upgrading it, following these [[.:indexmenu#The tree is not displayed|instructions]]. The full changelog can be viewed at my [[http://samuele.netsons.org/dokuwiki/doku.php?id=dokuwiki:plugins:indexmenu#changelog|indexmenu]] page. |
+^Many thanks to [[user>Klap-in|Klap-in]], all the work for the 5.0 release was done by him. ^
+==== Github changelog ====
+{{rss>https://github.com/samuelet/indexmenu/commits/master.atom 10 date}}
+===== Development =====
+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 [[.:indexmenu#the tree is not displayed]] section.
+===== Translations =====
+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!
+====== JavaScript themes ======
+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 [[https://github.com/samuelet/indexmenu/issues|GitHub]].
+The JavaScript tree menu is based on [[http://www.destroydrop.com/javascripts/tree/|dTree]] code.
+==== Theme tutorial ====
+You can create custom themes for every index rendered with the [[http://www.destroydrop.com/javascripts/tree/|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                             | {{https://raw.github.com/samuelet/indexmenu/master/images/default/base.gif}}           |
+| folderopen.gif     | Open folder without URL link            | {{https://raw.github.com/samuelet/indexmenu/master/images/default/folderopen.gif}}     |
+| folder.gif         | Closed folder without URL link          | {{https://raw.github.com/samuelet/indexmenu/master/images/default/folder.gif}}         |
+| folderhopen.gif    | Open folder with URL link (headpage)    | {{https://raw.github.com/samuelet/indexmenu/master/images/default/folderhopen.gif}}    |
+| folderh.gif        | Closed folder with URL link (headpage)  | {{https://raw.github.com/samuelet/indexmenu/master/images/default/folderh.gif}}        |
+| page.gif           | Page                                    | {{https://raw.github.com/samuelet/indexmenu/master/images/default/page.gif}}           |
+| plus.gif           |                                         | {{https://raw.github.com/samuelet/indexmenu/master/images/default/plus.gif}}           |
+| minus.gif          |                                         | {{https://raw.github.com/samuelet/indexmenu/master/images/default/minus.gif}}          |
+| nolines_plus.gif   |                                         | {{https://raw.github.com/samuelet/indexmenu/master/images/default/nolines_plus.gif}}   |
+| nolines_minus.gif  |                                         | {{https://raw.github.com/samuelet/indexmenu/master/images/default/nolines_minus.gif}}  |
+| minusbottom.gif    |                                         | {{https://raw.github.com/samuelet/indexmenu/master/images/default/minusbottom.gif}}    |
+| plusbottom.gif     |                                         | {{https://raw.github.com/samuelet/indexmenu/master/images/default/plusbottom.gif}}     |
+| join.gif           |                                         | {{https://raw.github.com/samuelet/indexmenu/master/images/default/join.gif}}           |
+| joinbottom.gif     |                                         | {{https://raw.github.com/samuelet/indexmenu/master/images/default/joinbottom.gif}}     |
+| line.gif           |                                         | {{https://raw.github.com/samuelet/indexmenu/master/images/default/line.gif}}           |
+| empty.gif          | blank image to fill gap between lines   | {{https://raw.github.com/samuelet/indexmenu/master/images/default/empty.gif}}          |
+Use your theme with **''js#mytheme''** syntax.
+You can also customize a theme style further by creating its [[#Custom theme CSS style|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.
+===== The context menu =====
+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 \\ <code javascript>
+indexmenu_contextmenu['all']['pg']['view'][0] = ['Custom Title'];
+</code>
+  * Adding menu entry \\ <code javascript>
+indexmenu_contextmenu['all']['pg']['view'].splice(
+,
+,
+    ['Input new page', '"javascript: IndexmenuContextmenu.reqpage(\'"+index.config.urlbase+"\',\'"+index.config.sepchar+"\',\'"+node.dokuid+"\');"']
+ );
+</code>
+  * 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)'' ([[https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/splice|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:
+^File ^Loaded by^
+|"menu.js" |anonymous user|
+|"usrmenu.js" |authenticated user|
+|"admmenu.js" |admin user((see [[config:superuser]]))|
+And to prevent to load the context menu, simply remove the indexmenu_contextmenu variable declared in the above menu files.
+====== CSS Style ======
+You can override styling from the [[https://github.com/samuelet/indexmenu/blob/master/style.css|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 [[devel:css]]).
+Some styles are:
+^Tag                  ^Comment                                        ^Mode  ^
+|a.nodeFdUrl          |Namespace with URL link (headpage)             |js    |
+|a.node               |Namespace without URL link                     |js    |
+|a.nodeUrl            |Page                                           |js    |
+|a.nodeSel            |Previous selected page or headpage highlight   |js    |
+|a.navSel             |Current page highlight                         |js    |
+|a.indexmenu_idx_head |link style of a namespace with URL (headpage)  |nojs  |
+|a.indexmenu_idx      |link style of a namespace without URL          |nojs  |
+|.indexmenu_arrow     |The scrolling arrow area                       |js    |
+|.indexmenu_toc       |The toc-preview area                           |js    |
+===== Custom theme CSS style =====
+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.
+FIXME check if this example is still up-to-date. For example you could add for the 'thread' theme:
+<code css 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
+}
+</code>
+Existing example for 'human.png' theme: ''[[https://github.com/samuelet/indexmenu/blob/master/images/human.png/style.css|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 [[https://github.com/samuelet/indexmenu/commit/d8d19c6bf2179113cda7f2e567f1c424d6282950|CSS changeset]] could be useful.
+====== FAQ and Notes ======
+====  The tree is not working as expected ====
+  * 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 [[.indexmenu#changelog]] is working.\\ Try to follow instructions to purge cache described in the [[.indexmenu#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 [[.indexmenu#syntax]], and read carefully the [[plugin:indexmenu#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 [[.indexmenu#FAQ and Notes]] section.
+  * Still no solution? Check if someone reported your issue at the [[https://github.com/samuelet/indexmenu/issues|Issue tracker]].
+  * Okay, now I believe that indexmenu is really not working as needed. Please report a detailed bug at the [[https://github.com/samuelet/indexmenu/issues|Issue tracker]], where you mentioned your syntax and configuration options and I'll try to find a solution in my spare time.
+==== The tree is not displayed ====
+Follows these instructions:
+  - To have installed an indexmenu release compatible with your DokuWiki version as described in [[indexmenu#how to install]].
+  - To have the last indexmenu version installed. For example check that its date is the same of [[.:indexmenu#changelog]] last release through the info button in plugin manager.
+  - To have used a correct [[.:indexmenu#syntax]].
+  - To have purged CSS and JavaScript and more as cached by DokuWiki. Go to the [[plugin:config|Configuration Manager]] and just resave, to refresh this caching.
+  - To have purged your browser cache. Use ''Ctrl + R'' or ''Ctrl + F5''
+  - 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 [[.:indexmenu#reporting_feature_requests_and_bugs]] section.
+==== I see nothing in sidebar when I login like user ====
+Check your ACL settings, please note that the user needs at least READ permissions to the page "sidebar".
+==== DokuWiki is getting slow ====
+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 [[plugin:indexmenu#syntax|max]] option, which rebuilds only a single tree portion (sublevel) and enable AJAX for further user-requested sublevels.
+==== Indexmenu ID conflict ====
+I have in my sidebar the following code
+<code>
+{{indexmenu>:#1| js navbar id#random }}
+</code>
+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 [[:plugin:nosidebar|Nosidebar plugin]] to remove the sidebar on the sidebar page.
+==== Can I sort the tree nodes (filename or page heading or creation time)? ====
+Yes, You can sort pages with the tsort, dsort or msort [[.:indexmenu#syntax]] options. To sort namespaces you need to add the nsort option to previouses.
+==== How can I activate the indexmenu as sidebar for every page? ====
+  - Enable the sidebar function in your template. See [[faq:sidebar|FAQ sidebar]] for configuration and installing.
+  - 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 not updated ====
+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 [[config:cachetime|purge cache time]] expiration or force it through a [[:devel:caching#purging_the_cache|purge=true]] request on the page that contains the indexmenu tree.
+==== JS does not remember its previous state ====
+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 //**[[.:indexmenu#syntax|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.
+==== I don't like the tree sliding arrow ====
+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 [[.:indexmenu#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;}''
+==== About ACLs ====
+|:!: First of all, you could need to correctly set the [[.:indexmenu#Acl cache]] option in order to avoid displaying of denied pages.|
+Indexmenu tree behaviour depends also on the [[config: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 [[.:indexmenu#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:
+<code>
++-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)
+</code>
+**Enabled** will display:
+<code>
++-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)
+</code>
+**Disabled** will display:
+<code>
++-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)
+</code>
+==== About empty namespaces ====
+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 [[.:indexmenu#skip namespaces in index]] or [[.:indexmenu#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 ''[[config: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]].
+==== I'm using "useheading" but the tree displays namespace and page names rather than headings ====
+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.((See [[:taskrunner]].))  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.
+====== Reporting feature requests and bugs======
+Please refer to https://github.com/samuelet/indexmenu/issues to share your feature requests and bug reports.
+See also for additional info:
+  * [[.:indexmenu#FAQ and notes]]
+  * and [[plugin:indexmenu:Discussion]] page
+====== Discussion ======
+Please, use the [[.:indexmenu:discussion]] page for feature requests and general discussion.\\ Old discussions are archived in the [[.:indexmenu:olddiscussion]] page.