差别

这里会显示出您选择的修订版和当前版本之间的差别。

--- wiki:插件语法:indexmenu [2022/10/19 09:08] – 创建 zhangguo
+++ wiki:插件语法:indexmenu [2026/10/15 21:29] (当前版本) – 外部编辑 127.0.0.1
@@ 行 1: / 行 1: @@
-====== IndexMenu Plugin ======
+# IndexMenu Plugin
 ---- plugin ----
 description: Show a customizable and sortable index for a namespace
@@ 行 17: / 行 16: @@
 downloadurl: https://github.com/samuelet/indexmenu/archive/master.zip
 donationurl: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=102873
-----
+---
+^ :!: If you use the Indexmenu's option 'js' in the Hogfather release (June 2020+), you have to disable the [defer_js feature flag](config:defer_js). The indexmenu plugin does not support deferred javascript loading at the moment.    Work-in-progress: [issue #230](https://github.com/samuelet/indexmenu/issues/230)  ^
-^ :!: If you use the Indexmenu's option 'js' in the Hogfather release (June 2020+), you have to disable the [[config:defer_js|defer_js feature flag]]. The indexmenu plugin does not support deferred javascript loading at the moment.\\ \\ Work-in-progress: [[https://github.com/samuelet/indexmenu/issues/230|issue #230]]  ^
 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]].
+It should be useful in DokuWiki sites where pages are organized by [namespaces](namespaces).
 Main features are:
-  * Fully customizable with a lot of [[.:indexmenu#syntax|flexible options]], but easy to use and configure for standard needs.
+  * Fully customizable with a lot of [flexible options](.:indexmenu#syntax), 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]].
+  * Easily themeable with prebuilt [JavaScript themes](.:indexmenu#JavaScript themes).
-  * Assign [[.:indexmenu#Namespaces title and link (headpages)]] to namespaces.
+  * Assign [Namespaces title and link (headpages)](.: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.
+  * Customizable [context mouse menu](.:indexmenu#The context menu) for usual namespace/page actions.
   * TOC pages preview.
-  * [[.:indexmenu#page_index|Replace]] the DokuWiki page index.
+  * [Replace](.:indexmenu#page_index) the DokuWiki page index.
-  * Hide namespaces/pages according to [[ACLs]] and plugin [[.indexmenu#skip_index|settings]].
+  * Hide namespaces/pages according to [ACLs](ACLs) and plugin [settings](.indexmenu#skip_index).
-Themed indexmenu based on the Javascript index builder:\\
+Themed indexmenu based on the Javascript index builder:\
-{{http://samuele.netsons.org/dokuwiki/media/indexmenu1.jpg}}\\
+![indexmenu1.jpg](http://samuele.netsons.org/dokuwiki/media/indexmenu1.jpg)\
-Indexmenu based on Dokuwikis index builder:\\
+Indexmenu based on Dokuwikis index builder:\
-{{http://samuele.netsons.org/dokuwiki/media/indexmenu2.jpg}}
+![indexmenu2.jpg](http://samuele.netsons.org/dokuwiki/media/indexmenu2.jpg)
-  * You can test it at the playground page of the [[http://samuele.netsons.org/dokuwiki/doku.php?id=dokuwiki:plugins:indexmenu|indexmenu web site]].
+  * You can test it at the playground page of the [indexmenu web site](http://samuele.netsons.org/dokuwiki/doku.php?id=dokuwiki:plugins:indexmenu).
-  * Thanks to Geir Landrö and his JavaScript [[http://www.destroydrop.com/javascripts/tree/|dTree]] menu.
+  * Thanks to Geir Landrö and his JavaScript [dTree](http://www.destroydrop.com/javascripts/tree/) 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).
+  * **Many many thanks to indexmenu users**, the most useful work is done by them (look at the [discussion](.:indexmenu:discussion) page).
-  * Feel free to [[.:indexmenu#development|improve]] it.
+  * Feel free to [improve](.:indexmenu#development) it.
-===== Donation =====
+## Donation
 The indexmenu plugin is not sponsored by anyone but I develop and support it for free during my spare time.
-If 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]].
+If want to offer me a friendly beer ((![180px-Tennent%27s_77.JPG](https://upload.wikimedia.org/wikipedia/commons/thumb/8/82/Tennent%27s_77.JPG/180px-Tennent%27s_77.JPG))), you can consider to make a [donation](http://samuele.netsons.org/dokuwiki/doku.php?id=dokuwiki:plugins:indexmenu#donation).
-====Examples:====
+### Examples:
-|Root namespace. Expands all |''%%{{indexmenu>:}}%%'' |
-|Current namespace. Show only current level, don't expand any nodes. |''%%{{indexmenu>.#1}}%%'' |
-|Parent namespace. Show parent namespace ("uplink") and current level, don't expand any nodes. |''%%{{indexmenu>..:#1}}%%'' |
-|''wiki'' namespace, expand containing namespaces, not subnamespaces.\\ Using the themed Javascript indexmenu. |''%%{{indexmenu>:wiki#1|js}}%%'' |
+| Root namespace. Expands all | `%%{{indexmenu>:}}%%` |
+| --- | --- |
+| Current namespace. Show only current level, don't expand any nodes. | `%%{{indexmenu>.#1}}%%` |
+| Parent namespace. Show parent namespace ("uplink") and current level, don't expand any nodes. | `%%{{indexmenu>..:#1}}%%` |
+| `wiki` namespace, expand containing namespaces, not subnamespaces.  Using the themed Javascript indexmenu. | `%%{{indexmenu>:wiki#1\|js}}%%` |
-====== Syntax ======
+# Syntax
 **Minimum syntax:**
-  * ''**%%{{indexmenu>.}}%%**''
+  * `**%%{{indexmenu>.}}%%**`
-  * ''**%%{{indexmenu>:}}%%**''
+  * `**%%{{indexmenu>:}}%%**`
-  * ''**%%{{indexmenu>|}}%%**''
+  * `**%%{{indexmenu>|}}%%**`
-That means this ''**%%{{indexmenu}}%%**'' and this ''**%%{{indexmenu>}}%%**'' do not work.
+That means this `**%%{{indexmenu}}%%**` and this `**%%{{indexmenu>}}%%**` do not work.
 **Basic syntax usage:**
-^ 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.
-:!: All the syntax options can be easily accessed with the indexmenu picker in the [[:edit window]] [[:toolbar]].
+| 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.
+:!: All the syntax options can be easily accessed with the indexmenu picker in the [edit window](edit window) [toolbar](toolbar).
-===== Full syntax =====
+## Full syntax
 Settings **before the "|"** separator:
-^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.|
+| Main | Action | Note |
-^ //''#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.|
+| _`ns`_ | _**Main namespace**_ name. Index starts from here. Syntax complies with DokuWiki [namespaces](namespaces#creating 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](namespaces#creating 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):
-^Option ^Action ^Note|
-^ ''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.|
-^ //''#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**// |
-| Next options are available with or without //**js**// option. |||
-^ ''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 but grouped separately. | 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.  |
-^ ''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. |||
-^ ''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**//|
+| Option | Action | Note |
+| --- | --- | --- |
+| `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. |
+| _`#theme`_   undo: `#default` | Theme name for indexmenu icons | A theme is a set of icons inside `_images_` directory as described in [Theme tutorial](.:indexmenu#Theme tutorial). Admins can download and share themes in admin panel. It works only in _**js**_ e.g. _**js#tango**_ |
+| Next options are available with or without _**js**_ option. |  | |
+| `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` | [Relative](namespaces#creating namespaces) _**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 [useheading](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 [metadata](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 [metadata tag syntax](.indexmenu#metadata tag syntax)).  With `#meta` parameter you can refer to the [meta data structure](devel:metadata#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 [startpage](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 but grouped separately. | To use in _addition_ to the above sort options. tsort, dsort, msort, hsort apply only for namespaces when using [headpages](#namespaces_title_and_link_headpages). rsort is applicable always together with nsort. |
+| `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 [startpage](config:startpage) setting) |
+| `skipfile[+\|=]/regexp/` | Skip files matching the regexp. | `skipfile**+**/../` skips files defined with this regexp additional to [global skip](#skip_files_in_index) config. `skipfile**=**/../` replace the global skip config with regexp from this syntax. See the global config explanation for some regexp [examples](#skip_namespaces_in_index). |
+| `skipns[+\|=]/regexp/` | Skip namespaces matching the regexp. | Just like skipfile, but [namespaces](#skip_namespaces_in_index). |
+| Next options are _only_ available with _**js**_ option. |  | |
+| `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` | [Cookie](https://en.wikipedia.org/wiki/HTTP_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 [Js does not remember its previous state](.: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 [cookies](https://en.wikipedia.org/wiki/HTTP_cookie). 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**_ |
-===== Examples =====
+## Examples
 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>
+```
-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>
+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](.indexmenu#Metadata tag syntax) number:
+```
 {{indexmenu>..#1|js#thread navbar max#3#2 tsort msort}}
-</code>
+```
 Standard DokuWiki index showing only pages inside wiki:plugins and lower namespaces (max two levels):
-<code>
+```
 {{indexmenu>:wiki:plugins#2|nons}}
-</code>
+```
-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:
-<code>
+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](.:indexmenu#Namespaces title and link (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}}
-</code>
+```
 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>
+```
 Show all current namespace pages .
-<code>
+```
 {{indexmenu>.:#1|context}}
-</code>
+```
 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.
-<code>
+```
 {{indexmenu>private|js nopg dsort}}
-</code>
+```
-==== Metadata tag syntax ====
+### Metadata tag syntax
 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:
-<code>
+```
 {{indexmenu_n>N}}
-</code>
+```
-Where ''N'' is a number.
+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").
+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:
+You can change the order of this tree containing a mix of standard and [useheading](config:useheading) pages:
-<file>
+~~~
 -Root
   |_don
@@ 行 174: / 行 192: @@
   |_van
   |_vliet
-</file>
+~~~
 in this way:
-<code>
+```
 {{indexmenu>..#1|msort}}
-</code>
+```
-<file>
+~~~
 -Root
   |_vliet                   {{indexmenu_n>1}}
@@ 行 188: / 行 210: @@
   |_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}}
@@ 行 202: / 行 228: @@
   |_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.
+# Configuration options
+Indexmenu is fully configurable from [Configuration Manager](plugin:config). Options are explained in the below sections.
-==== Default options=====
+### 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.
+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 ====
+### 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.
@@ 行 219: / 行 244: @@
-==== ACL Cache ====
+### ACL Cache
 Optimize the cache of indexmenu according to ACLs and prevents to display unauthorized nodes.
@@ 行 230: / 行 254: @@
 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.
+There are also important issues in [about ACLs](.:indexmenu#about ACLs) and [about_empty_namespaces](.:indexmenu#about_empty_namespaces) that affects trees limited by ACLs.
-==== Namespaces title and link (headpages) ====
+### 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 [useheading](config:useheading) on in the general configuration of the wiki. Indexmenu will show page titles when useheading is 'always' or 'navigation'.
-== Titles for page headings ==
+##### 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`.
-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).
@@ 行 247: / 行 268: @@
 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.
+| 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 [start](config:startpage) page name inside the namespace | public(ns):start(page) |
-== Hide headpages in tree ==
+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.
+##### 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 ====
+### Page index
+When this option is not empty, the DokuWiki default [index](index) page is replaced with a custom page, which you can fill yourself. For example you can add the indexmenu tree of your site.
-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:
-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.
+You may also want to hide this page in any indexmenu trees with the [skip files in index](.:indexmenu#skip files in index) option.
-==== Empty message ====
+### 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)
@@ 行 284: / 行 308: @@
-==== Skip Namespaces in Index ====
+### Skip Namespaces in Index
+The configuration setting `skip_index` let you globally hide namespaces (and their pages) in your indexmenu trees.
-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](http://www.php.net/manual/en/reference.pcre.pattern.syntax.php).\
-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.
+There are also some issues [About empty namespaces](.:indexmenu#About empty namespaces) that should be read.
-**Simple examples:**\\
+**Simple examples:**\
-Skip any namespace whose ID contains the word ''copyright'' or ''privatens:users''. Attention: ''allprivatens:usersmich'' will be also matched
+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>
+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$/
-</code>
+```
-==== Skip Files in index====
-This configuration option ''skip_file'' let you to globally hide one or more pages in your indexmenu trees.
+### Skip Files in index
-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]].\\
+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](http://www.php.net/manual/en/reference.pcre.pattern.syntax.php).\
 :!: 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.
+There are also some issues [About empty namespaces](.:indexmenu#About empty namespaces) that should be read.
-==== Show sort ====
+### Show sort
+If you sorted a page with the [metadata tag syntax](.:indexmenu#metadata tag syntax), a short blob message at the top of page will display its sort number.
-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 ======
+# How to install
+Search and install the plugin using the [Extension Manager](plugin:extension). Refer to [Plugins](Plugins) on how to install plugins manually.
-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]]
+[Old releases](http://samuele.netsons.org/dokuwiki/doku.php?id=dokuwiki:plugins:indexmenu#old_releases)
-===== Changelog =====
+## Changelog
+|:!: You could need to purge your browser and server cache after upgrading it, following these [instructions](.:indexmenu#The tree is not displayed). The full changelog can be viewed at my [indexmenu](http://samuele.netsons.org/dokuwiki/doku.php?id=dokuwiki:plugins:indexmenu#changelog) page. |
-|:!: 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 [Klap-in](/doku.php?id=start&do=loginKlap-in), all the work for the 5.0 release was done by him. ^
-^Many thanks to [[user>Klap-in|Klap-in]], all the work for the 5.0 release was done by him. ^
-==== Github changelog ====
+### Github changelog
 {{rss>https://github.com/samuelet/indexmenu/commits/master.atom 5 date}}
-==== Release changelog ====
+### Release changelog
   * **2014-08-01**
       * Default options can be configured in Config Manager for whole wiki
@@ 行 351: / 行 372: @@
   * **2013-04-24 Version 5.0**:
             * Reformat of all code to Dokuwiki code style
-            * Rewrite all javascript to jQuery instead of old js api (includes improvements from [[tindexmenu]] plugin)
+            * Rewrite all javascript to jQuery instead of old js api (includes improvements from [tindexmenu](tindexmenu) plugin)
             * Added a new toolbar wizard
             * Used Dokuwikis javascript include mechanism
-            * add ''hsort'' for sorting [[config:startpage]] pages to top of listing
+            * add `hsort` for sorting [startpage](config:startpage) pages to top of listing
             * Rewrite the ajax stuff into action plugin (not theme handling stuff)
             * Change configuration via menu js files to one file.
-            * add option ''nomenu''
+            * add option `nomenu`
-            * Improved support for [[config:useheading]] option. Page titles are //only shown// when useheading is 'always' or 'navigation'. - by [[user>lupo49]]
+            * Improved support for [useheading](config:useheading) option. Page titles are _only shown_ when useheading is 'always' or 'navigation'. - by [user>lupo49](/doku.php?id=start&do=loginlupo49)
-            * Added syntax option to add ''skipfile+/regexp/'' and ''skipns+/regexp/''. Using ''+'' add regexp parallel to global config, using ''='' replaces the global config.
+            * Added syntax option to add `skipfile+/regexp/` and `skipns+/regexp/`. Using `+` add regexp parallel to global config, using `=` replaces the global config.
             * Adding curid span like DokuWiki performs on internal links.
             * Fixed: When only had indexmenu syntax in sidebar, in js rendered index the backup index wasn't hidden.
-            * Fixed: Ajax completion supports Korean characters too. - by [[user>Samuele]]
+            * Fixed: Ajax completion supports Korean characters too. - by [user>Samuele](/doku.php?id=start&do=loginSamuele)
   * **2009-08-29 Version 4.6**:
-            * :!: //New Feature//: Namespace declaration complies with DokuWiki [[:namespaces#creating namespaces|namespaces]]. **Important before upgrading from previous versions**: according to the new DokuWiki syntax, a simple //main namespace// without relative declaration prefix (i.e: "playground") doesn't refer anymore to the subnamespace in the root namespace but in the **current** namespace. To refer to the root namespace, you need to prepend the ":" declaration to it.
+            * :!: _New Feature_: Namespace declaration complies with DokuWiki [namespaces](namespaces#creating namespaces). **Important before upgrading from previous versions**: according to the new DokuWiki syntax, a simple _main namespace_ without relative declaration prefix (i.e: "playground") doesn't refer anymore to the subnamespace in the root namespace but in the **current** namespace. To refer to the root namespace, you need to prepend the ":" declaration to it.
-            * //New Feature//: Added the //context// option. It resolves relative requested namespaces starting from the current user location instead of the page containing the indexmenu syntax.
+            * _New Feature_: Added the _context_ option. It resolves relative requested namespaces starting from the current user location instead of the page containing the indexmenu syntax.
-            * :!: //New Feature//: Changed skip_file and skip_index syntax to use DokuWiki ID instead of system paths. Thanks to Dmitry Katsubo.
+            * :!: _New Feature_: Changed skip_file and skip_index syntax to use DokuWiki ID instead of system paths. Thanks to Dmitry Katsubo.
-            * //New Feature//: Metatada titles are not rendered when recursively building the indexmenu tree. This will speed up the page loading when cache expires, but could not display the heading title for nodes without metadata information.
+            * _New Feature_: Metatada titles are not rendered when recursively building the indexmenu tree. This will speed up the page loading when cache expires, but could not display the heading title for nodes without metadata information.
-            * //New Feature//: Added the nojs button in the edit toolbar and toolbar CSS classes.
+            * _New Feature_: Added the nojs button in the edit toolbar and toolbar CSS classes.
-            * //New Feature//: The right JS context menu is closed by any document click. Thanks to Urban.
+            * _New Feature_: The right JS context menu is closed by any document click. Thanks to Urban.
-            * //Bug//: Fixed a bug which prevents page caching when it contains only indexmenu syntax.
+            * _Bug_: Fixed a bug which prevents page caching when it contains only indexmenu syntax.
-            * //Bug//: Disable JS indexmenu cookies in preview mode.
+            * _Bug_: Disable JS indexmenu cookies in preview mode.
-            * //Bug//: Fixed an ACL issue.
+            * _Bug_: Fixed an ACL issue.
-            * //Bug//: Fixed UTF8 TOC preview bug.
+            * _Bug_: Fixed UTF8 TOC preview bug.
-===== Development =====
+## 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.
+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](.:indexmenu#the tree is not displayed) section.
-===== Translations =====
+## 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 ======
+# JavaScript themes
+With the option `js` you enable the JavaScript tree menu, for which you can chosen some 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.
-When the ''js'' option is used without //**#theme**// option, the JavaScript indexmenu will use the default theme.
 Inside the Admin panel on the Indexmenu Utilities page you can manage the available themes on your installation and install themes from the public indexmenu repository. To download themes directly into your DokuWiki server, you need that the indexmenu images directory is writable by the web user.
-Instead of installing you can also simply download a theme into your PC with the ''download'' link, and then manually install it.
+Instead of installing you can also simply download a theme into your PC with the `download` link, and then manually install it.
-The JavaScript tree menu is based on [[http://www.destroydrop.com/javascripts/tree/|dTree]] code.
+The JavaScript tree menu is based on [dTree](http://www.destroydrop.com/javascripts/tree/) code.
-==== Theme tutorial ====
+### Theme tutorial
+You can create custom themes for every index rendered with the [dTree](http://www.destroydrop.com/javascripts/tree/) menu.
-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:
-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' |
-^ Icon               ^ Type                                    ^ Example: theme 'default'                                                               ^
+| --- | --- | --- |
-| base.gif           | Root Folder                             | {{https://raw.github.com/samuelet/indexmenu/master/images/default/base.gif}}           |
+| base.gif | Root Folder | ![base.gif](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}}     |
+| folderopen.gif | Open folder without URL link | ![folderopen.gif](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}}         |
+| folder.gif | Closed folder without URL link | ![folder.gif](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}}    |
+| folderhopen.gif | Open folder with URL link (headpage) | ![folderhopen.gif](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}}        |
+| folderh.gif | Closed folder with URL link (headpage) | ![folderh.gif](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}}           |
+| page.gif | Page | ![page.gif](https://raw.github.com/samuelet/indexmenu/master/images/default/page.gif) |
-| plus.gif           |                                         | {{https://raw.github.com/samuelet/indexmenu/master/images/default/plus.gif}}           |
+| plus.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}}          |
+| minus.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_plus.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}}  |
+| nolines_minus.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}}    |
+| minusbottom.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}}     |
+| plusbottom.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}}           |
+| join.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}}     |
+| joinbottom.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}}           |
+| line.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}}          |
+| empty.gif | blank image to fill gap between lines | ![empty.gif](https://raw.github.com/samuelet/indexmenu/master/images/default/empty.gif) |
-Use your theme with **''js#mytheme''** syntax.
+Use your theme with **`js#mytheme`** syntax.
-You can also customize a theme style further by creating its [[.:indexmenu#Custom theme CSS style|own css style]] as ''style.css'' file in theme folder next to the images.
+You can also customize a theme style further by creating its [own css style](.:indexmenu#Custom theme 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 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 =====
+## 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''.
+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.
+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.
+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'':\\
+Modification of menu in performed in `scripts/contextmenu.local.js`:\
-(You can rename the example file from ''scripts/contextmenu.local.js.example'')
+(You can rename the example file from `scripts/contextmenu.local.js.example`)
-  * Overriding menu entry \\ <code javascript>
+  * Overriding menu entry\
+```javascript
 indexmenu_contextmenu['all']['pg']['view'][0] = ['Custom Title'];
-</code>
+```
-  * Adding menu entry \\ <code javascript>
+  * Adding menu entry\
+```javascript
 indexmenu_contextmenu['all']['pg']['view'].splice(
 ,
@@ 行 450: / 行 471: @@
     ['Input new page', '"javascript: IndexmenuContextmenu.reqpage(\'"+index.config.urlbase+"\',\'"+index.config.sepchar+"\',\'"+node.dokuid+"\');"']
  );
-</code>
+```
   * Removing menu entry:
-    * Override with empty array: ''[]''
+    * Override with empty array: `[]`
-    * Or use ''.splice(entryIndexNo, 1);'' with ''entryIndexNo'' as the entry position
+    * 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]]):
+Some details about `Array.splice(entryIndexNo, howManyToRemove, entryDescriptionArray)` ([documentation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/splice)):
-  * ''entryIndexNo'' - position of entry, start counting at zero
+  * `entryIndexNo` - position of entry, start counting at zero
-  * ''howManyToRemove'' - number of entries to be removed. Set to zero to only add entries.
+  * `howManyToRemove` - number of entries to be removed. Set to zero to only add entries.
-  * ''entryDescriptionArray'' - array with description of a menu entry
+  * `entryDescriptionArray` - array with description of a menu entry
-**How to write utf8 chars, like èåäö, in the context menu file?**\\
+**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 'ã'
+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:
+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|
+| File | Loaded by |
-|"usrmenu.js" |authenticated user|
+| --- | --- |
-|"admmenu.js" |admin user((see [[config:superuser]]))|
+| "menu.js" | anonymous user |
+| "usrmenu.js" | authenticated user |
+| "admmenu.js" | admin user((see [superuser](config:superuser))) |
 And to prevent to load the context menu, simply remove the indexmenu_contextmenu variable declared in the above menu files.
-====== CSS Style ======
+# CSS Style
+You can override styling from the [style.css](https://github.com/samuelet/indexmenu/blob/master/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](devel:css)).
-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    |
+| 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.
+## 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>
+```css lib/plugins/indexmenu/images/thread/style.css
 /*Custom style for the thread theme*/
@@ 行 509: / 行 534: @@
   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.
+Existing example for 'human.png' theme: `[style.css](https://github.com/samuelet/indexmenu/blob/master/images/human.png/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](https://github.com/samuelet/indexmenu/commit/d8d19c6bf2179113cda7f2e567f1c424d6282950) could be useful.
-====== FAQ and Notes ======
-====  The tree is not working as expected ====
+# 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 [changelog](.indexmenu#changelog) is working.\
+ Try to follow instructions to purge cache described in the [The tree is not displayed](.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 [syntax](.indexmenu#syntax), and read carefully the [configuration](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 [FAQ and Notes](.indexmenu#FAQ and Notes) section.
+  * Still no solution? Check if someone reported your issue at the [Issue tracker](https://github.com/samuelet/indexmenu/issues).
+  * Okay, now I believe that indexmenu is really not working as needed. Please report a detailed bug at the [Issue tracker](https://github.com/samuelet/indexmenu/issues), where you mentioned your syntax and configuration options and I'll try to find a solution in my spare time.
-  * 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 ====
+### 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 installed an indexmenu release compatible with your DokuWiki version as described in [how to install](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 the last indexmenu version installed. For example check that its date is the same of [changelog](.:indexmenu#changelog) last release through the info button in plugin manager.
-  - To have used a correct [[.:indexmenu#syntax]].
+  - To have used a correct [syntax](.:indexmenu#syntax).
-  - To have purged your browser cache. Use ''Ctrl + R'' or ''Ctrl + F5''
+  - To have purged your browser cache. Use `Ctrl + R` or `Ctrl + F5`
-  - To have purged server cache following the [[:caching#purging_the_cache]] instructions.:!: This is an important step.
+  - To have purged server cache following the [purging_the_cache](caching#purging_the_cache) instructions.:!: This is an important step.
   - To have purged CSS and JavaScript as cached by DokuWiki. Go to the Configuration Manager and just resave, to refresh this caching.
   - 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.
+If problem still persists, please, report the bug with details of your configuration in [reporting_feature_requests_and_bugs](.:indexmenu#reporting_feature_requests_and_bugs) section.
-==== I see nothing in sidebar when I login like user ====
+### 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 ====
+### 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.
+To avoid this problem you may use the [max](plugin:indexmenu#syntax) option, which rebuilds only a single tree portion (sublevel) and enable AJAX for further user-requested sublevels.
-==== Indexmenu ID conflict ====
+### 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?
+and I get after saving this message: `Indexmenu ID conflict`. What's wrong?
@@ 行 568: / 行 595: @@
 > 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.
+>> A workaround to get rid of the warning message, is to use the [Nosidebar plugin](plugin:nosidebar) to remove the sidebar on the sidebar page.
-==== Can I sort the tree nodes (filename or page heading or creation time)? ====
+### Can I sort the tree nodes (filename or page heading or creation time)?
+Yes, You can sort pages with the tsort, dsort or msort [syntax](.:indexmenu#syntax) options. To sort namespaces you need to add the nsort option to previouses.
-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.
-==== 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.
@@ 行 581: / 行 607: @@
-==== The tree is not updated ====
+### 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.
+To purge cache either wait for the automatic [purge cache time](config:cachetime) expiration or force it through a [purge=true](devel:caching#purging_the_cache) request on the page that contains the indexmenu tree.
-==== JS does not remember its previous state ====
+### 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.
-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.
-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](.:indexmenu#syntax)**_ option.
-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 ====
+### 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`.
-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](.:indexmenu#Css Style) according to the size of your image.
-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.
-==== About ACLs ====
+### About ACLs
+|:!: First of all, you could need to correctly set the [Acl cache](.:indexmenu#Acl cache) option in order to avoid displaying of denied pages.|
-|:!: 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 [sneaky_index](config:sneaky_index) option in this way:
-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.
@@ 行 615: / 行 637: @@
   * **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.\\
+In both cases, unauthorized pages are never showed. There are also some issues [About empty namespaces](.: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)
@@ 行 632: / 行 655: @@
  -start          (page) (allowed)
  -start2         (page) (denied)
-</code>
+```
 **Enabled** will display:
-<code>
+```
 +-Mysite         (dir)
  +-public        (dir)
@@ 行 642: / 行 667: @@
    -X           (empty/unauthorized icon **displayed only in case of any sort option**)
  -start          (page)
-</code>
+```
 **Disabled** will display:
-<code>
+```
 +-Mysite         (dir)
  +-private       (dir)
@@ 行 655: / 行 682: @@
    -X           (empty/unauthorized icon **displayed only in case of any sort option**)
  -start          (page)
-</code>
+```
-==== About empty namespaces ====
+### 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 skipped by [skip namespaces in index](.:indexmenu#skip namespaces in index) or [skip files in index](.:indexmenu#skip files in index) options.
-   * All its pages and namespaces are denied to users by [[ACLs]] settings.
+   * All its pages and namespaces are denied to users by [ACLs](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.
+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?**\\
+**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.
+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**\\
+**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]].
+Enabling the `[sneaky_index](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](#About ACLs).
-==== I'm using "useheading" but the tree displays namespace and page names rather than headings ====
+### 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](metadata) store.  DokuWiki uses a background process triggered by a web-bug to updating this metadata.((See [taskrunner](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.
-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======
+# 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]]
+  * [FAQ and notes](.:indexmenu#FAQ and notes)
-  * and [[plugin:indexmenu:Discussion]] page
+  * and [Discussion](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.
+# Discussion
+Please, use the [discussion](.:indexmenu:discussion) page for feature requests and general discussion.\
+ Old discussions are archived in the [olddiscussion](.:indexmenu:olddiscussion) page.